@spectrum-web-components/avatar - npm Package Compare versions

Comparing version 0.2.6 to 0.2.7-alpha.38

package.json

@@ -21,15 +21,24 @@ {
     ],
-    "version": "0.2.6",
+    "version": "0.2.7-alpha.38+3926abb2",
     "description": "",
-    "main": "lib/index.js",
-    "module": "lib/index.js",
+    "main": "src/index.js",
+    "module": "src/index.js",
     "type": "module",
+    "exports": {
+        "./src/": "./src/",
+        "./custom-elements.json": "./custom-elements.json",
+        "./package.json": "./package.json",
+        "./sp-avatar": "./sp-avatar.js",
+        "./sp-avatar.js": "./sp-avatar.js"
+    },
     "files": [
         "custom-elements.json",
-        "/lib/",
+        "*.d.ts",
+        "*.js",
+        "*.js.map",
         "/src/"
     ],
     "sideEffects": [
-        "./lib/index.js",
-        "./src/index.ts"
+        "./sp-avatar.js",
+        "./sp-avatar.ts"
     ],
@@ -41,6 +50,2 @@ "scripts": {
     "license": "Apache-2.0",
-    "peerDependencies": {
-        "lit-element": "^2.1.0",
-        "lit-html": "^1.0.0"
-    },
     "devDependencies": {
@@ -50,5 +55,7 @@ "@spectrum-css/avatar": "^2.0.5"
     "dependencies": {
+        "lit-element": "^2.1.0",
+        "lit-html": "^1.0.0",
         "tslib": "^2.0.0"
     },
-    "gitHead": "16b57d15356859cee73278cdf796274e3245320b"
+    "gitHead": "3926abb2769a9bab28762bf3b3e1fab7c5f03589"
 }

README.md

 ## Description
 
-An **sp-avatar** is a great way to feature a visual representation of a user.
+An `<sp-avatar>` is a great way to feature a visual representation of a user.
 
-### Installation
+### Usage
 
@@ -11,9 +11,17 @@ [![See it on NPM!](https://img.shields.io/npm/v/@spectrum-web-components/avatar?style=for-the-badge)](https://www.npmjs.com/package/@spectrum-web-components/avatar)
 ```
-npm install @spectrum-web-components/avatar
+yarn add @spectrum-web-components/avatar
+```
 
-# or
+Import the side effectful registration of `<sp-avatar>` via:
 
-yarn add @spectrum-web-components/avatar
 ```
+import '@spectrum-web-components/avatar/sp-avatar.js';
+```
 
+When looking to leverage the `Avatar` base class as a type and/or for extension purposes, do so via:
+
+```
+import { Avatar } from '@spectrum-web-components/avatar';
+```
+
 ## Example
@@ -20,0 +28,0 @@

src/index.ts

@@ -12,15 +12,2 @@ /*
 */
-export * from './avatar.js';
-
-import { Avatar } from './avatar.js';
-
-/* istanbul ignore else */
-if (!customElements.get('sp-avatar')) {
-    customElements.define('sp-avatar', Avatar);
-}
-
-declare global {
-    interface HTMLElementTagNameMap {
-        'sp-avatar': Avatar;
-    }
-}
+export * from './Avatar.js';

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 5 instances 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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 6 instances in 1 package

Improved metrics

Number of low license alerts

5

decreased by-16.67%

Number of lines in readme file

35

increased by29.63%

Worsened metrics

Total package byte prevSize

36945

decreased by-22.57%

Number of package files

28

decreased by-20%

Lines of code

282

decreased by-28.43%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedlit-element@^2.1.0

• + Addedlit-html@^1.0.0