the-traveler - npm Package Compare versions

Comparing version 0.1.8 to 0.2.0

build/enums.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
+ * Enum for the Bungie membership type
+ * @enum
+ */
+var BungieMembershipType;
+(function (BungieMembershipType) {
+    BungieMembershipType[BungieMembershipType["All"] = -1] = "All";
+    BungieMembershipType[BungieMembershipType["Xbox"] = 1] = "Xbox";
+    BungieMembershipType[BungieMembershipType["PSN"] = 2] = "PSN";
+    BungieMembershipType[BungieMembershipType["PC"] = 4] = "PC";
+    BungieMembershipType[BungieMembershipType["Bungie"] = 254] = "Bungie";
+})(BungieMembershipType = exports.BungieMembershipType || (exports.BungieMembershipType = {}));
+/**
  * Enum for Desinty component type
@@ -91,14 +103,2 @@ * @enum
 /**
- * Enum for the Bungie membership type
- * @enum
- */
-var BungieMembershipType;
-(function (BungieMembershipType) {
-    BungieMembershipType[BungieMembershipType["All"] = -1] = "All";
-    BungieMembershipType[BungieMembershipType["Xbox"] = 1] = "Xbox";
-    BungieMembershipType[BungieMembershipType["PSN"] = 2] = "PSN";
-    BungieMembershipType[BungieMembershipType["PC"] = 4] = "PC";
-    BungieMembershipType[BungieMembershipType["Bungie"] = 254] = "Bungie";
-})(BungieMembershipType = exports.BungieMembershipType || (exports.BungieMembershipType = {}));
-/**
  * Enum for Destiny period type
@@ -115,9 +115,44 @@ * @enum
 /**
- * Enum for different search types
+ * Enum for different type definitions
  * @enum
  */
-var SearchType;
-(function (SearchType) {
-    SearchType["DestinyInventoryItemDefinition"] = "DestinyInventoryItemDefinition";
-})(SearchType = exports.SearchType || (exports.SearchType = {}));
+var TypeDefinition;
+(function (TypeDefinition) {
+    TypeDefinition["DestinyActivityGraphDefinition"] = "DestinyActivityGraphDefinition";
+    TypeDefinition["DestinyActivityModeDefinition"] = "DestinyActivityModeDefinition";
+    TypeDefinition["DestinyActivityModifierDefinition"] = "DestinyActivityModifierDefinition";
+    TypeDefinition["DestinyActivityTypeDefinition"] = "DestinyActivityTypeDefinition";
+    TypeDefinition["DestinyBondDefinition"] = "DestinyBondDefinition";
+    TypeDefinition["DestinyClassDefinition"] = "DestinyClassDefinition";
+    TypeDefinition["DestinyDamageTypeDefinition"] = "DestinyDamageTypeDefinition";
+    TypeDefinition["DestinyDestinationDefinition"] = "DestinyDestinationDefinition";
+    TypeDefinition["DestinyEnemyRaceDefinition"] = "DestinyEnemyRaceDefinition";
+    TypeDefinition["DestinyFactionDefinition"] = "DestinyFactionDefinition";
+    TypeDefinition["DestinyGenderDefinition"] = "DestinyGenderDefinition";
+    TypeDefinition["DestinyHistoricalStatsDefinition"] = "DestinyHistoricalStatsDefinition";
+    TypeDefinition["DestinyInventoryBucketDefinition"] = "DestinyInventoryBucketDefinition";
+    TypeDefinition["DestinyInventoryItemDefinition"] = "DestinyInventoryItemDefinition";
+    TypeDefinition["DestinyItemCategoryDefinition"] = "DestinyItemCategoryDefinition";
+    TypeDefinition["DestinyItemTierTypeDefinition"] = "DestinyItemTierTypeDefinition";
+    TypeDefinition["DestinyLocationDefinition"] = "DestinyLocationDefinition";
+    TypeDefinition["DestinyLoreDefinition"] = "DestinyLoreDefinition";
+    TypeDefinition["DestinyMedalTierDefinition"] = "DestinyMedalTierDefinition";
+    TypeDefinition["DestinyMilestoneDefinition"] = "DestinyMilestoneDefinition";
+    TypeDefinition["DestinyObjectiveDefinition"] = "DestinyObjectiveDefinition";
+    TypeDefinition["DestinyPlaceDefinition"] = "DestinyPlaceDefinition";
+    TypeDefinition["DestinyProgressionDefinition"] = "DestinyProgressionDefinition";
+    TypeDefinition["DestinyProgressionLevelRequirementDefinition"] = "DestinyProgressionLevelRequirementDefinition";
+    TypeDefinition["DestinyRaceDefinition"] = "DestinyRaceDefinition";
+    TypeDefinition["DestinyRewardSourceDefinition"] = "DestinyRewardSourceDefinition";
+    TypeDefinition["DestinySackRewardItemListDefinition"] = "DestinySackRewardItemListDefinition";
+    TypeDefinition["DestinySandboxPerkDefinition"] = "DestinySandboxPerkDefinition";
+    TypeDefinition["DestinySocketCategoryDefinition"] = "DestinySocketCategoryDefinition";
+    TypeDefinition["DestinySocketTypeDefinition"] = "DestinySocketTypeDefinition";
+    TypeDefinition["DestinyStatDefinition"] = "DestinyStatDefinition";
+    TypeDefinition["DestinyStatGroupDefinition"] = "DestinyStatGroupDefinition";
+    TypeDefinition["DestinyTalentGridDefinition"] = "DestinyTalentGridDefinition";
+    TypeDefinition["DestinyUnlockDefinition"] = "DestinyUnlockDefinition";
+    TypeDefinition["DestinyVendorCategoryDefinition"] = "DestinyVendorCategoryDefinition";
+    TypeDefinition["DestinyVendorDefinition"] = "DestinyVendorDefinition";
+})(TypeDefinition = exports.TypeDefinition || (exports.TypeDefinition = {}));
 /**
@@ -124,0 +159,0 @@ * Enum for different stat IDs

package.json

 {
     "name": "the-traveler",
-    "version": "0.1.8",
+    "version": "0.2.0",
     "description": "A Node.js API wrapper for the Destiny 2 API",
@@ -19,4 +19,6 @@ "keywords": [
     "files": [
-        "build/traveler.js",
-        "build/enums.js"
+        "build/Traveler.js",
+        "build/enums.js",
+        "build/HttpService.js",
+        "build/OAuthError.js"
     ],
@@ -23,0 +25,0 @@ "scripts": {

README.md

 Table of Contents
 =================
 
+   * [Table of Contents](#table-of-contents)
    * [The Traveler](#the-traveler)
@@ -15,2 +16,4 @@ * [Getting Started](#getting-started)
          * [Get a character for an PSN Account](#get-a-character-for-an-psn-account)
+         * [Transfer item from vault to character (needs OAuth)](#transfer-item-from-vault-to-character-needs-oauth)
+         * [Async await approach (pseudo-code)](#async-await-approach-pseudo-code)
       * [Progress](#progress)
@@ -23,3 +26,2 @@ * [Built With](#built-with)
 
-
 # The Traveler
@@ -148,2 +150,3 @@
 ```
+So the refresh procedure has to be initiated manually, there is no automatic refresh implemented.
 
@@ -159,2 +162,3 @@ To wrap this up, the flow is the following:
 * After the oauth object is set on the traveler object you can query the endpoints which require authentiation
+    * You can try to use this approach with `async` and `await` to overcome the `callback hell`, see [Async await approach (pseudo-code)](#async-await-approach-pseudo-code)
 * Keep in mind that it would be very useful to store the tokens for your users _**securely**_!
@@ -277,2 +281,45 @@
 
+### Transfer item from vault to character (needs OAuth)
+
+`traveler.oauth` has to be set before calling this method
+
+```
+traveler
+    .transferItem({
+        itemReferenceHash: '2907129556',
+        stackSize: 1,
+        transferToVault: false,
+        itemId: '6917529033189743362',
+        characterId: 'yourCharacterId',
+        membershipType: Enums.BungieMembershipType.PSN
+    })
+    .then(result => {
+        console.log(result);
+    })
+    .catch(err => {
+        console.log(err);
+    });
+```
+
+### Async await approach (pseudo-code)
+
+Just a thought about using `async` and `await`
+
+```
+async () => {
+    const traveler = new Traveler({
+        apikey: 'pasteYourAPIkey',
+        userAgent: 'yourUserAgent', //used to identify your request to the API
+        oauthClientId: 'yourClientId',
+        oauthClientSecret: 'yourClientSecret',
+    });
+
+    traveler.oauth = await traveler.getAccessToken(accessCode);
+    // OR 
+    traveler.oauth = await traveler.refreshToken(refreshToken);
+
+    // now do your calls
+}
+```
+
 ## Progress
@@ -292,8 +339,8 @@
 | Destiny2.GetVendor                        | ![alt text][yes] | ![alt text][preview]  |
-| Destiny2.TransferItem                     | ![alt text][no]  | ![alt text][unlocked] |
-| Destiny2.EquipItem                        | ![alt text][no]  | ![alt text][unlocked] |
-| Destiny2.EquipItems                       | ![alt text][no]  | ![alt text][unlocked] |
-| Destiny2.SetItemLockState                 | ![alt text][no]  | ![alt text][unlocked] |
-| Destiny2.InsertSocketPlug                 | ![alt text][no]  | ![alt text][preview]  |
-| Destiny2.ActivateTalentNode               | ![alt text][no]  | ![alt text][preview]  |
+| Destiny2.TransferItem                     | ![alt text][yes] | ![alt text][unlocked] |
+| Destiny2.EquipItem                        | ![alt text][yes] | ![alt text][unlocked] |
+| Destiny2.EquipItems                       | ![alt text][yes] | ![alt text][unlocked] |
+| Destiny2.SetItemLockState                 | ![alt text][yes] | ![alt text][unlocked] |
+| Destiny2.InsertSocketPlug                 | ![alt text][yes] | ![alt text][preview]  |
+| Destiny2.ActivateTalentNode               | ![alt text][yes] | ![alt text][preview]  |
 | Destiny2.GetPostGameCarnageReport         | ![alt text][yes] | ![alt text][unlocked] |
@@ -300,0 +347,0 @@ | Destiny2.GetHistoricalStatsDefinition     | ![alt text][yes] | ![alt text][unlocked] |

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

Improved metrics

Total package byte prevSize

94707

increased by25.11%

Number of package files

7

increased by40%

Lines of code

1434

increased by32.9%

Number of lines in readme file

382

increased by14.03%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes