Merge pull request #119 from LottieFiles/feat/get-versions

feat: added getVersions, updated lottie-web

Author: samuelOsborne

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.5.0
+
+### Minor Changes
+
+- 978552b: added getVersions(), updated lottie-web
+
 ## 3.4.9
 
 ### Patch Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lottiefiles/react-lottie-player",
-  "version": "3.4.9",
+  "version": "3.5.0",
   "description": "Lottie web player wrapper for React",
   "main": "dist/lottie-react.js",
   "module": "dist/lottie-react.esm.js",
@@ -82,10 +82,12 @@
     "react": "16 - 18"
   },
   "dependencies": {
-    "lottie-web": "^5.7.8"
+    "lottie-web": "^5.10.0"
   },
   "scripts": {
+    "predev": "node -p \"'export const LOTTIE_PLAYER_VERSION = ' + JSON.stringify(require('./package.json').version) + '; \\n' + 'export const LOTTIE_WEB_VERSION = ' + JSON.stringify(require('./package.json').dependencies['lottie-web']) + ';'\" > src/versions.ts",
     "dev": "rollup -c -w",
+    "prebuild": "node -p \"'export const LOTTIE_PLAYER_VERSION = ' + JSON.stringify(require('./package.json').version) + '; \\n' + 'export const LOTTIE_WEB_VERSION = ' + JSON.stringify(require('./package.json').dependencies['lottie-web']) + ';'\" > src/versions.ts",
     "build": "rollup -c",
     "prepublishOnly": "yarn build",
     "run-tests": "while ! nc -z localhost 8080 ; do sleep 1 ; done && yarn run start-cypress && npx nyc report --reporter=text-summary",

src/Player.tsx

@@ -1,6 +1,8 @@
 import lottie, { AnimationItem } from 'lottie-web';
 import * as React from 'react';
 
+import { LOTTIE_PLAYER_VERSION, LOTTIE_WEB_VERSION } from './versions';
+
 /**
  * Parse a resource into a JSON object or a URL string
  */
@@ -56,6 +58,11 @@ export enum PlayerEvent {
   Frame = 'frame',
 }
 
+export type Versions = {
+  lottieWebVersion: string;
+  lottiePlayerVersion: string;
+};
+
 export type PlayerDirection = -1 | 1;
 
 export interface IPlayerProps {
@@ -126,6 +133,16 @@ export class Player extends React.Component<IPlayerProps, IPlayerState> {
     };
   }
 
+  /**
+   * Returns the lottie-web version and this player's version
+   */
+  public getVersions(): Versions {
+    return {
+      lottieWebVersion: LOTTIE_WEB_VERSION,
+      lottiePlayerVersion: LOTTIE_PLAYER_VERSION,
+    };
+  }
+
   static defaultProps = {
     loop: false,
   };

src/versions.ts

@@ -0,0 +1,2 @@
+export const LOTTIE_PLAYER_VERSION = '3.4.9';
+export const LOTTIE_WEB_VERSION = '^5.10.0';

stories/index.stories.tsx

@@ -1,6 +1,7 @@
 import '@storybook/addon-console';
 
 import * as React from 'react';
+import { useCallback, useRef, useEffect } from 'react';
 
 import { Controls } from '../src/Controls';
 import { Player } from '../src/Player';
@@ -12,13 +13,25 @@ export default {
   },
 };
 
-export const LottiePlayer = () => {
-  const onEvent = (event: any) => {
+export const LottiePlayer = (): any => {
+  const playerRef = useRef(null);
+
+  const onEvent = useCallback((event: any) => {
     console.log('event', event);
-  };
+  }, []);
+
+  useEffect(() => {
+    if (playerRef !== null && playerRef.current !== null) {
+      // @ts-ignore: Object is possibly 'null'.
+      console.log(playerRef.current.getVersions());
+      console.log('Calling versions()');
+    }
+  }, [playerRef]);
+
   return (
     <div style={{ width: '374px' }}>
       <Player
+        ref={playerRef}
         src="https://assets1.lottiefiles.com/packages/lf20_ybj0fjlo.json"
         hover
         loop

yarn.lock

@@ -12691,10 +12691,10 @@ loose-envify@^1.0.0, loose-envify@^1.1.0, loose-envify@^1.4.0:
   dependencies:
     js-tokens "^3.0.0 || ^4.0.0"
 
-lottie-web@^5.7.8:
-  version "5.9.1"
-  resolved "https://registry.yarnpkg.com/lottie-web/-/lottie-web-5.9.1.tgz#0090e575de74e49843606c1722767604e068f061"
-  integrity sha512-3uKtU6BhIK6ZRCE/QyiXq/KuRvPeEAz/VFwqd99jPbpgFY9gHLw2krqvcuCFGepeW94BipS/B3TqIfTc9pUeZg==
+lottie-web@^5.10.0:
+  version "5.10.0"
+  resolved "https://registry.yarnpkg.com/lottie-web/-/lottie-web-5.10.0.tgz#72563f22efdcf2b8f7e8359743514930ebaf5f8c"
+  integrity sha512-q2hfqKrGXNkwjSSZjKxf3fWMi0e3ZBc03qBkVWoGbwUJ7BcG+9YXjMPtmmhitzk8Nc6VQ5PRnh9yInPdfq0PZg==
 
 lower-case@^2.0.2:
   version "2.0.2"