kashi 3.0.0 → 3.0.2

package/README.md

@@ -101,31 +101,82 @@ Since the library was designed primarily to be used with vanilla JS, a _helper_
 > **Note**: There is TypeScript support, and even if your project doesn't use the JS superset, it should help VSCode and other editors provide autocomplete/code suggestions.
 
 ```tsx
-import { useEffect, useRef } from "react";
+import { memo, useEffect, useRef } from "react";
 import { Kashi, KashiProps } from "kashi";
 
+import { api } from "@/services/axios";
+
 // Example using Vite, React and TypeScript
-export const KashiWrapper = (props: Omit<KashiProps, "container">) => {
-  const ref = useRef<HTMLDivElement>(null);
-
-  useEffect(() => {
-    if (ref.current) {
-      new Kashi({
-        ...props,
-        container: ref.current,
-      });
-    }
+export const KashiWrapper = memo(
+  (props: Omit<KashiProps, "container"> & { url: string }) => {
+    const ref = useRef<HTMLDivElement>(null);
+
+    useEffect(() => {
+      async function loadKashi() {
+        if (!ref.current) {
+          return;
+        }
+
+        if (!props.url) {
+          ref.current.innerHTML = "";
+          return;
+        }
+
+        try {
+          const { url, ...rest } = props;
+
+          const response = await api.get(url, { responseType: "blob" });
+
+          new Kashi({
+            ...rest,
+            file: response.data,
+            container: ref.current,
+          });
+        } catch (error) {
+          console.error("Error loading Kashi:", error);
+        }
+      }
 
-    return () => {
-      // Required to avoid duplication when React is in Strict Mode
-      if (ref.current) {
-        ref.current.innerHTML = "";
+      loadKashi();
+
+      return () => {
+        // Required to avoid duplication when React is in Strict Mode
+        if (ref.current) {
+          ref.current.innerHTML = "";
+        }
+      };
+    }, [ref.current, props]);
+
+    return <div className="kashi-wrapper" ref={ref} />;
+  },
+  (prevProps, nextProps) => {
+    function compareObjects(
+      obj1: Omit<KashiProps, "container">,
+      obj2: Omit<KashiProps, "container">,
+    ) {
+      const keys1 = Object.keys(obj1) as Array<
+        keyof Omit<KashiProps, "container">
+      >;
+      const keys2 = Object.keys(obj2) as Array<
+        keyof Omit<KashiProps, "container">
+      >;
+
+      if (keys1.length !== keys2.length) {
+        return false;
       }
-    };
-  }, [ref.current]);
 
-  return <div className="kashi-wrapper" ref={ref} />;
-};
+      for (const key of keys1) {
+        if (obj1[key] !== obj2[key]) {
+          return false;
+        }
+      }
+
+      return true;
+    }
+
+    return compareObjects(prevProps, nextProps);
+  },
+);
 ```
 
 ## 🧐 Constructor properties
@@ -149,7 +200,7 @@ Here's an example:
 
 ```html
 <div id="kashi">
-  <sp>
+  <p>
     <span data-time="00:17.55" data-ms-time="17550" data-empty="false" data-aria-current="false">
       Telling myself, "I won't go there"
     </span>
@@ -174,7 +225,7 @@ Here's an example:
       Souls tied, intertwined by our pride and guilt
     </span>
     <!-- ... -->
-  </sp>
+  </p>
 </div>
 ```
 
@@ -189,7 +240,7 @@ The instance generated by `Kashi` has some public methods and attributes that ca
 | `noLyricsText`     | Attribute | Returns the text set for when there are no lyrics            |
 | `setFile`          | Method    | Function capable of changing the current lyrics file by passing the the new **file** |
 | `setEmptyLineText` | Method    | Function capable of changing the text defined for empty lines |
-| `noLyricsText`     | Method    | Function capable of changing the text defined for when there are no lyrics |
+| `setNoLyricsText`  | Method    | Function capable of changing the text defined for when there are no lyrics |
 | `subscribe`        | Method    | Function capable of defining a callback to be executed when a given event is triggered |
 | `unsubscribe`      | Method    | Function capable of making a callback to stop listening to an event |
 | `notify`           | Method    | Function capable of triggering an event                      |
@@ -202,7 +253,7 @@ When creating a new instance using `Kashi` you will have access to the `subscrib
 | ------------------- | --------------------------- | ------------------------------------------ |
 | `fileSet`           | `{ file: Blob }`            | When calling the `setFile` method          |
 | `emptyLineTextSet`  | `{ emptyLineText: string }` | When calling the `setEmptyLineText` method |
-| `noLyricsText`      | `{ noLyricsText: text }`    | When calling the `setNoLyricsText` method  |
+| `noLyricsTextSet`   | `{ noLyricsText: text }`    | When calling the `setNoLyricsText` method  |
 | `lyricLinesUpdated` | `{ lyricLines: string[] }`  | When inserting/updating lyrics in HTML     |
 
 ## 🤔 How do I run the project on my machine?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kashi",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Singing at the top of my lungs",
   "type": "module",
   "author": "lucasmc64",