@fileverse/heartbit-react - npm Package Compare versions

Comparing version 0.0.25 to 1.0.0

package.json

 {
   "name": "@fileverse/heartbit-react",
-  "version": "0.0.25",
+  "version": "1.0.0",
   "type": "module",
@@ -18,2 +18,7 @@ "main": "./dist/index.umd.js",
   },
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "tsc --project tsconfig.json && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
+  },
   "peerDependencies": {
@@ -45,10 +50,5 @@ "react": "^18.2.0",
   "dependencies": {
-    "classnames": "^2.5.1",
-    "@fileverse/heartbit-core": "0.0.22"
-  },
-  "scripts": {
-    "dev": "vite build --watch",
-    "build": "tsc --project tsconfig.json && vite build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
+    "@fileverse/heartbit-core": "workspace:*",
+    "classnames": "^2.5.1"
   }
-}
+}

README.md

@@ -5,3 +5,3 @@ # HeartBit React
 
-A plug-and-play integration of the HeartBit SDK, which is a wrapper around [HeartBitCore](https://github.com/fileverse/HeartBitSDK/tree/main/packages/heartbit-core).
+A plug-and-play integration of the [HeartBit SDK](https://github.com/fileverse/HeartBitSDK), which is a wrapper around [HeartBitCore](https://github.com/fileverse/HeartBitSDK/tree/main/packages/heartbit-core).
 
@@ -65,3 +65,3 @@ ## Getting Started
 
- const hash = keccak256(toUtf8Bytes("MY_APP_TOKEN"));
+ const hash = keccak256(toUtf8Bytes("window.location.href")); // This is an identifier for the token, if this hash changes you mint a new token in that case
 
@@ -78,5 +78,5 @@ return <HeartBit
 
-[Here](<(https://codesandbox.io/p/devbox/hearbit-example-cxr375)>) is a working example using HeartBit.
+[Here](https://codesandbox.io/p/devbox/hearbit-example-cxr375) is a working example using HeartBit.
 
-## Customization
+## Customisation
 
@@ -105,3 +105,3 @@ You can attach the HeartBit functionality to any UI component and instead of being restricted by our default heart icon. To achieve this, the `heartbit-react` package exports `HeartBitProvider` and `useHeartBit`. The `HeartBitProvider` is used to configure the core package with the `coreOptions`, and `useHeartBit` exposes the core functions of the HeartBit SDK, which we can call in a React component. Note that it can only be used in the context of `HeartBitProvider`.
      const address = '0x...someaddress'
-     const hash = '0x....somehash'
+     const hash = '0x....somehash' // This is an identifier for the token, if this hash changes you mint a new token in that case
      useEffect(() => {
@@ -126,3 +126,3 @@ const fetchBalances = async () => {
             endTime,
-            hash, // keccak256 hash of a string
+            hash, // This is an identifier for the token, if this hash changes you mint a new token in that case
             message, // raw message that was signed
@@ -136,3 +136,51 @@ signature, // signed message
 ```
+[Here](https://codesandbox.io/p/devbox/custom-heartbit-example-p6f7gr) is a working example using the `HeartBitProvider` and `useHeartBit`.
 
-[Here](https://codesandbox.io/p/devbox/custom-heartbit-example-p6f7gr) is a working example using the `HeartBitProvider` and `useHeartBit`.
+
+### Interface
+```javascript
+interface SignatureArgs {
+  message: string;
+  signature: string;
+  onMintCallback?: () => void; // will be called after NFT minting is done
+}
+interface HeartBitProps
+  extends Omit<HeartBitUIProps, "isDisabled" | "startFillPos"> {
+  coreOptions: HeartBitCoreOptions;
+  getSignatureArgsHook: () => Promise<SignatureArgs>; // this is a required hook, this allows to call sign message operation on the user wallet, must return SignatureArgs
+  hash: string; // This is an identifier for the token, if this hash changes you mint a new token in that case
+  address?: string; // user wallet address
+  showTotalMintsByHash?: boolean; // Default to false, if true will show total mints for a hash to the right of component
+  showTotalMintsByUser?: boolean; // Defaults to false, if true will show total mints by a user on a hash to right of the component
+}
+
+
+type SupportedChain = "0xaa36a7" | "0x2105";
+interface HeartBitCoreOptions {
+  chain: SupportedChain;
+  rpcUrl?: string;
+}
+interface HeartBitProviderProps {
+  children: React.ReactNode;
+  coreOptions: HeartBitCoreOptions;
+}
+interface TotalHeartBitCountArgs {
+  hash: string; // This is an identifier for the token, if this hash changes you mint a new token in that case
+}
+interface HeartBitCountByUserArgs {
+  hash: string; // This is an identifier for the token, if this hash changes you mint a new token in that case
+  address: string; // ethereum wallet address
+}
+interface MintHeartBitArgs {
+  message: string;
+  signature: string;
+  startTime: number; // in seconds
+  endTime: number; // in seconds
+  hash: string; // This is an identifier for the token, if this hash changes you mint a new token in that case
+}
+interface IHeartBitContext {
+  getTotalHeartMintsByUser: (opts: HeartBitCountByUserArgs) => Promise<number>;
+  getTotalHeartBitByHash: (opts: TotalHeartBitCountArgs) => Promise<number>;
+  mintHeartBit: (opts: MintHeartBitArgs) => Promise<void>;
+}
+```

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3118731

increased by0.07%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

181

increased by36.09%

Dependency changes

• - Removed@adraffy/ens-normalize@1.10.1(transitive)

• - Removed@fileverse/heartbit-core@0.0.22(transitive)

• - Removed@noble/curves@1.2.0(transitive)

• - Removed@noble/hashes@1.3.2(transitive)

• - Removed@types/node@18.15.13(transitive)

• - Removedaes-js@4.0.0-beta.5(transitive)

• - Removedethers@6.13.0(transitive)

• - Removedtslib@2.4.0(transitive)

• - Removedws@8.5.0(transitive)

• Updated@fileverse/heartbit-core@workspace:*