@api-components/api-annotation-document - npm Package Compare versions

Comparing version 3.0.0-preview.1 to 3.0.0-preview.2

api-annotation-document.d.ts

@@ -8,10 +8,11 @@ /**
  * To modify these typings, edit the source file(s):
- *   api-annotation-document.html
+ *   api-annotation-document.js
  */
 
-/// <reference path="../polymer/types/polymer-element.d.ts" />
-/// <reference path="../polymer/types/lib/elements/dom-repeat.d.ts" />
-/// <reference path="../polymer/types/lib/elements/dom-if.d.ts" />
-/// <reference path="../amf-helper-mixin/amf-helper-mixin.d.ts" />
 
+// tslint:disable:variable-name Describing an API that's defined elsewhere.
+// tslint:disable:no-any describes the API as best we are able today
+
+export {ApiAnnotationDocument};
+
 declare namespace ApiElements {
@@ -40,3 +41,3 @@
   class ApiAnnotationDocument extends
-    ApiElements.AmfHelperMixin(
+    AmfHelperMixin(
     Object) {
@@ -112,4 +113,7 @@
 
-interface HTMLElementTagNameMap {
-  "api-annotation-document": ApiElements.ApiAnnotationDocument;
+declare global {
+
+  interface HTMLElementTagNameMap {
+    "api-annotation-document": ApiElements.ApiAnnotationDocument;
+  }
 }

api-annotation-document.js

@@ -1,6 +0,4 @@
-import {PolymerElement} from '@polymer/polymer/polymer-element.js';
+import {PolymerElement} from '../../@polymer/polymer/polymer-element.js';
 import {html} from '../../@polymer/polymer/lib/utils/html-tag.js';
-import '@polymer/polymer/lib/elements/dom-repeat.js';
-import '@polymer/polymer/lib/elements/dom-if.js';
-import {AmfHelperMixin} from '@api-components/amf-helper-mixin/amf-helper-mixin.js';
+import {AmfHelperMixin} from '../../@api-components/amf-helper-mixin/amf-helper-mixin.js';
 /**
@@ -32,3 +30,3 @@ * `api-annotation-document`
  */
-class ApiAnnotationDocument extends AmfHelperMixin(PolymerElement) {
+export class ApiAnnotationDocument extends AmfHelperMixin(PolymerElement) {
   static get template() {
@@ -35,0 +33,0 @@ return html`

package.json

@@ -13,3 +13,3 @@ {
   "name": "@api-components/api-annotation-document",
-  "version": "3.0.0-preview.1",
+  "version": "3.0.0-preview.2",
   "license": "Apache-2.0",
@@ -48,8 +48,2 @@ "main": "api-annotation-document.js",
   },
-  "resolutions": {
-    "inherits": "2.0.3",
-    "samsam": "1.1.3",
-    "supports-color": "3.1.2",
-    "type-detect": "1.0.0"
-  },
   "contributors": [
@@ -62,5 +56,5 @@ "Pawel Psztyc",
     "@api-components/api-console-default-theme": "^3.0.0-preview.1",
-    "@api-components/api-navigation": "^3.0.0-preview.1",
+    "@api-components/api-navigation": "^3.0.0-preview.2",
     "@polymer/polymer": "^3.0.0"
   }
 }

README.md

@@ -1,19 +0,10 @@
-[![Build Status](https://travis-ci.org/advanced-rest-client/api-url-data-model.svg?branch=stage)](https://travis-ci.org/advanced-rest-client/api-annotation-document)
+[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-annotation-document.svg)](https://www.npmjs.com/package/@api-components/api-annotation-document)
 
-[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/advanced-rest-client/api-annotation-document)
+[![Build Status](https://travis-ci.org/api-components/api-annotation-document.svg?branch=stage)](https://travis-ci.org/api-components/api-annotation-document)
 
-# api-annotation-document
+[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/api-components/api-annotation-document)
 
-An element to render RAML annotations based on AMF data model
+## <api-annotation-document>
 
-<!---
-```
-<custom-element-demo>
-  <template>
-    <link rel="import" href="api-annotation-document.html">
-    <next-code-block></next-code-block>
-  </template>
-</custom-element-demo>
-```
--->
+An element to render RAML annotations based on AMF data model.
 
@@ -26,2 +17,61 @@ ```html
 
-This components is a part of API components ecosystem: https://elements.advancedrestclient.com/
+This components is a part of [API components ecosystem](https://elements.advancedrestclient.com/)
+
+## Usage
+
+### Installation
+```
+npm install --save @api-components/api-annotation-document
+```
+
+### In an html file
+
+```html
+<html>
+  <head>
+    <script type="module">
+      import '@api-components/api-annotation-document/api-annotation-document.js';
+    </script>
+  </head>
+  <body>
+    <api-annotation-document></api-annotation-document>
+  </body>
+</html>
+```
+
+### In a Polymer 3 element
+
+```js
+import {PolymerElement, html} from '@polymer/polymer';
+import '@api-components/api-annotation-document/api-annotation-document.js';
+
+class SampleElement extends PolymerElement {
+  static get template() {
+    return html`
+    <api-annotation-document></api-annotation-document>
+    `;
+  }
+}
+customElements.define('sample-element', SampleElement);
+```
+
+### Installation
+
+```sh
+git clone https://github.com/api-components/api-annotation-document
+cd api-url-editor
+npm install
+npm install -g polymer-cli
+```
+
+### Running the demo locally
+
+```sh
+polymer serve --npm
+open http://127.0.0.1:<port>/demo/
+```
+
+### Running the tests
+```sh
+polymer test --npm
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

77

increased by185.19%

Worsened metrics

Total package byte prevSize

15864

decreased by-88.84%

Number of package files

5

decreased by-76.19%

Lines of code

323

decreased by-94.54%

Dependency changes

• Updated@api-components/api-navigation@^3.0.0-preview.2