@poap-xyz/drops - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "@poap-xyz/drops",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Drops module for the poap.js library",
@@ -5,0 +5,0 @@ "main": "dist/cjs/index.cjs",

README.md

@@ -5,33 +5,44 @@ # @poap-xyz/drops
 
-@poap-xyz/drops is a [short description of the purpose of the package].
+@poap-xyz/drops is a package to interact with POAP Drops.
 
 ## Features
 
-- Feature 1
-- Feature 2
-- Feature 3
+- Create a Drop
+- Update a Drop attributes
+- Fetch a single Drop
+- Fetch multiple Drops
 
 ## Installation
 
+### NPM
+
 ```bash
-npm install @poap-xyz/drops
+npm install @poap-xyz/drops @poap-xyz/utils @poap-xyz/providers axios form-data
 ```
 
+### Yarn
+
+```bash
+yarn add @poap-xyz/drops @poap-xyz/utils @poap-xyz/providers axios form-data
+```
+
 ## Usage
 
-\```python
-from package_name import module
+```javascript
+  import { DropsClient } from '@poap-xyz/drops';
+  import { PoapCompass, PoapDropApi } from '@poap-xyz/providers';
 
-# Example usage
-result = module.function(parameter)
-print(result)
-\```
+  const client = new DropsClient(
+    new PoapCompass('you_api_key'),
+    new PoapDropApi('your_api_key'),
+  );
+```
 
 ## Documentation
 
-For more detailed documentation, please visit [link to your documentation].
+For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs).
 
 ## Examples
 
-For example scripts and usage, please check the `examples` folder.
+For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples).
 
@@ -38,0 +49,0 @@ ## Contributing

src/DropsClient.ts

@@ -16,3 +16,3 @@ import {
 import { CreateDropsInput, FetchDropsInput, UpdateDropsInput } from './types';
-import { PaginatedResult } from '@poap-xyz/utils';
+import { PaginatedResult, nextCursor } from '@poap-xyz/utils';
 
@@ -93,7 +93,6 @@ /**
     );
-    const endIndex = offset + drops.length;
 
     return new PaginatedResult<Drop>(
       drops,
-      endIndex < offset + limit ? null : endIndex,
+      nextCursor(drops.length, limit, offset),
     );
@@ -100,0 +99,0 @@ }

src/index.ts

 export { DropsClient } from './DropsClient';
-export { Drop } from './domain/drop';
+export { Drop } from './domain/Drop';

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

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

Improved metrics

Total package byte prevSize

77792

increased by623.38%

Number of package files

43

increased by230.77%

Lines of code

1245

increased by241.1%

Number of lines in readme file

55

increased by25%

No dependency changes