@lottiefiles/lottie-player - npm Package Compare versions

Comparing version 0.3.0-rc2 to 0.3.0

package.json

 {
   "name": "@lottiefiles/lottie-player",
-  "version": "0.3.0-rc2",
+  "version": "0.3.0",
   "description": "Lottie animation and Telegram Sticker player web components.",
@@ -14,23 +14,16 @@ "main": "dist/lottie-player.js",
   "scripts": {
-    "clean": "rimraf dist/*",
-    "build": "yarn clean && parcel build src/lottie-player.ts --detailed-report 50 --out-file lottie-player.js",
-    "lint": "eslint",
-    "lint:fix": "eslint --fix",
+    "build": "yarn build-lottie && yarn build-tgs",
+    "build-lottie": "parcel build src/lottie-player.ts --detailed-report 50 --out-file lottie-player.js",
+    "build-tgs": "parcel build src/tgs-player.ts --detailed-report 50 --out-file tgs-player.js",
     "start": "parcel src/index.html"
   },
   "dependencies": {
-    "lit-element": "^2.2.1",
-    "lottie-web": "^5.5.9"
+    "@types/pako": "^1.0.1",
+    "lit-element": "^2.3.1",
+    "lottie-web": "^5.6.6",
+    "pako": "^1.0.11"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^2.6.1",
-    "@typescript-eslint/parser": "^2.6.1",
-    "eslint": "^6.6.0",
-    "eslint-config-prettier": "^6.5.0",
-    "eslint-plugin-prettier": "^3.1.1",
-    "express": "^4.17.1",
     "parcel-bundler": "^1.12.4",
-    "prettier": "1.18.2",
-    "rimraf": "^3.0.0",
-    "typescript": "^3.7.2"
+    "typescript": "^3.4.5"
   },
@@ -47,3 +40,5 @@ "files": [
     "lit-element",
-    "player"
+    "player",
+    "telegram sticker",
+    "tgs"
   ],
@@ -50,0 +45,0 @@ "browserslist": [

README.md

 ## lottie-player Web Component
 
-This is a Web Component for easily embedding and playing Lottie animations on websites.
+This is a Web Component for easily embedding and playing Lottie animations and the Lottie-based Telegram Sticker (tgs) animations in websites.
 
@@ -8,8 +8,2 @@ [![npm](https://img.shields.io/npm/v/@lottiefiles/lottie-player.svg)](https://www.npmjs.com/package/@lottiefiles/lottie-player)
 
----
-
-Note: The Telegram Sticker TGS player has been moved to it's own [GitHub repository and npm library](https://github.com/LottieFiles/tgs-player).
-
----
-
 ## Demo
@@ -22,2 +16,6 @@
 
+## Documentation
+
+- [View documentation](https://lottiefiles.github.io/lottie-player/)
+
 ## Installation
@@ -32,3 +30,3 @@
 ```html
-<script src="https://unpkg.com/@lottiefiles/lottie-player@0.3.0/dist/lottie-player.js"></script>
+<script src="https://unpkg.com/@lottiefiles/lottie-player@0.2.0/dist/lottie-player.js"></script>
 ```
@@ -38,8 +36,27 @@
 
-````html
+```html
 <script src="/node_modules/@lottiefiles/lottie-player/dist/lottie-player.js"></script>
+```
 
-#### In Javascript or TypeScript: 1. Install package using npm or yarn. ```shell
+##### Telegram Sticker (TGS) Player:
+
+- Import from CDN.
+
+```html
+<script src="https://unpkg.com/@lottiefiles/lottie-player@0.2.0/dist/tgs-player.js"></script>
+```
+
+- Import from local node_modules directory.
+
+```html
+<script src="/node_modules/@lottiefiles/lottie-player/dist/tgs-player.js"></script>
+```
+
+#### In Javascript or TypeScript:
+
+1. Install package using npm or yarn.
+
+```shell
 npm install --save @lottiefiles/lottie-player
-````
+```
 
@@ -87,2 +104,11 @@ 2. Import package in your code.
 
+### TGS-Player
+
+Add the element `tgs-player` and set the `src` property to a URL pointing to a valid TGS JSON.
+
+```html
+<tgs-player autoplay loop mode="normal" src="https//domain/example.tgs">
+</tgs-player>
+```
+
 ## Properties
@@ -89,0 +115,0 @@

New alerts

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

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

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

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2729348

increased by146.83%

Dev dependency count

2

decreased by-80%

Number of package files

9

increased by80%

Lines of code

5790

increased by492.02%

Number of lines in readme file

280

increased by10.24%

Worsened metrics

Dependency count

4

increased by100%

Number of low quality alerts

3

increased by50%

Number of low supply chain risk alerts

5

increased by66.67%

Number of medium supply chain risk alerts

5

increased by66.67%

Dependency changes

• + Added@types/pako@^1.0.1

• + Addedpako@^1.0.11

• + Added@types/pako@1.0.7(transitive)

• + Addedpako@1.0.11(transitive)

• Updatedlit-element@^2.3.1

• Updatedlottie-web@^5.6.6