the-traveler - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

build/interfaces.d.ts

@@ -34,3 +34,3 @@ import { BungieMembershipType, ComponentPrivacySetting, ComponentType, DamageType, DestinyActivityDifficultyTier, DestinyActivityModeType, DestinyClass, DestinyGameVersion, DestinyGender, DestinyRace, DestinyStatsGroupType, DestinyTalentNodeState, EquipFailureReason, ItemBindStatus, ItemLocation, ItemState, PeriodType, PlatformErrorCodes, StatsCategoryType, TransferStatus, UnitType, VendorItemRefundPolicy, VendorItemStatus } from './enums';
 export interface IDestinyActivity {
-    activityHash: string;
+    activityHash: number;
     isNew: boolean;
@@ -52,3 +52,3 @@ canLead: boolean;
 export interface IDestinyAggregateActivityStats {
-    activityHash: string;
+    activityHash: number;
     values: {
@@ -63,3 +63,3 @@ [key: string]: IDestinyHistoricalStatsValue;
 export interface IDestinyMilestoneQuest {
-    questItemHash: string;
+    questItemHash: number;
     status: IDestinyQuestStatus;
@@ -83,4 +83,4 @@ activity: IDestinyMilestoneActivity;
     availableActivites: IDestinyActivity[];
-    currentActivityHash: string;
-    currentActivityModeHash: string;
+    currentActivityHash: number;
+    currentActivityModeHash: number;
     currentActivityModeType?: DestinyActivityModeType;
@@ -90,3 +90,3 @@ currentActivityModeHashes: string[];
     currentPlaylistActivityHash?: string;
-    lastCompletedStoryHash: string;
+    lastCompletedStoryHash: number;
 }
@@ -106,5 +106,5 @@ /**
     stats: object;
-    raceHash: string;
-    genderHash: string;
-    classHash: string;
+    raceHash: number;
+    genderHash: number;
+    classHash: number;
     raceType: DestinyRace;
@@ -115,3 +115,3 @@ classType: DestinyClass;
     emplemBackgroundPath: string;
-    emblemHash: string;
+    emblemHash: number;
     levelProgression: IDestinyProgression;
@@ -190,3 +190,3 @@ baseCharacterLevel: number;
 export interface IDestinyDefinition {
-    hash: string;
+    hash: number;
     index: number;
@@ -210,3 +210,3 @@ redacted: boolean;
 export interface IDestinyEntitySearchResultItem {
-    hash: string;
+    hash: number;
     entityType: string;
@@ -228,3 +228,3 @@ displayProperties: IDestinyDisplayPropertiesDefinition;
 export interface IDestinyFactionProgression extends IDestinyProgression {
-    factionHash: string;
+    factionHash: number;
 }
@@ -238,3 +238,3 @@ export interface IDestinyHistoricalStatsAccountResult {
     referenceId: string;
-    directorActivityHash: string;
+    directorActivityHash: number;
     isntanceId: string;
@@ -334,3 +334,3 @@ mode: DestinyActivityModeType;
 export interface IDestinyItemComponent {
-    itemHash: string;
+    itemHash: number;
     itemInstanceId: string;
@@ -340,3 +340,3 @@ quantity: number;
     location: ItemLocation;
-    bucketHash: string;
+    bucketHash: number;
     transferStatus: TransferStatus;
@@ -352,3 +352,3 @@ lockable: boolean;
     damageType: DamageType;
-    damageTypeHash: string;
+    damageTypeHash: number;
     primaryStat: IDestinyStat;
@@ -374,3 +374,3 @@ itemLevel: number;
 export interface IDestinyItemPeerView {
-    itemHash: string;
+    itemHash: number;
     dyes: IDyeReference;
@@ -390,3 +390,3 @@ }
 export interface IDestinyItemQuantity {
-    itemHash: string;
+    itemHash: number;
     itemInstanceId: string;
@@ -431,3 +431,3 @@ quantity: number;
 export interface IDestinyItemSocketState {
-    plugHash: string;
+    plugHash: number;
     isEnabled: boolean;
@@ -451,3 +451,3 @@ enableFailIndexes: number[];
 export interface IDestinyItemTalentGridComponent {
-    talentGridHash: string;
+    talentGridHash: number;
     nodes: IDestinyTalentNode[];
@@ -462,3 +462,3 @@ isGridComplete: boolean;
 export interface IDestinyItemTransferRequest {
-    itemReferenceHash: string;
+    itemReferenceHash: number;
     stackSize: number;
@@ -490,3 +490,3 @@ transferToVault: boolean;
 export interface IDestinyMaterialRequirement {
-    itemHash: string;
+    itemHash: number;
     deleteOnAction: boolean;
@@ -501,3 +501,3 @@ count: number;
 export interface IDestinyMilestone {
-    milestoneHash: string;
+    milestoneHash: number;
     availableQuests: IDestinyMilestoneQuest[];
@@ -515,4 +515,4 @@ values: object;
 export interface IDestinyMilestoneActivity {
-    activityHash: string;
-    modifierHash: string[];
+    activityHash: number;
+    modifierHash: number[];
     variants: IDestinyMilestoneActivityVariant[];
@@ -540,3 +540,3 @@ }
 export interface IDestinyMilestoneActivityVariant {
-    activityHash: string;
+    activityHash: number;
     completionStatus?: IDestinyMilestoneActivityCompletionStatus;
@@ -559,3 +559,3 @@ }
 export interface IDestinyMilestoneQuest {
-    questItemHash: string;
+    questItemHash: number;
     status: IDestinyQuestStatus;
@@ -570,3 +570,3 @@ activity: IDestinyMilestoneActivity;
 export interface IDestinyMilestoneRewardCategory {
-    rewardCategoryHash: string;
+    rewardCategoryHash: number;
     entries: IDestinyMilestoneRewardEntry[];
@@ -579,3 +579,3 @@ }
 export interface IDestinyMilestoneRewardEntry {
-    rewardEntryHash: string;
+    rewardEntryHash: number;
     earned: boolean;
@@ -589,3 +589,3 @@ redeemed: boolean;
 export interface IDestinyObjectiveProgress {
-    objectiveHash: string;
+    objectiveHash: number;
     destinationHash?: string;
@@ -601,3 +601,3 @@ activityHash?: string;
 export interface IDestinyPerkReference {
-    perkHash: string;
+    perkHash: number;
     iconPath: string;
@@ -693,3 +693,3 @@ isActive: boolean;
 export interface IDestinyProgression {
-    progressionHash: string;
+    progressionHash: number;
     dailyProgress: number;
@@ -707,3 +707,3 @@ dailyLimit: number;
 export interface IDestinyPublicMilestone {
-    milestoneHash: string;
+    milestoneHash: number;
     availableQuests: IDestinyPublicMilestoneQuest[];
@@ -715,3 +715,3 @@ vendorHashes: string[];
 export interface IDestinyPublicMilestoneActivity {
-    activitHash: string;
+    activitHash: number;
     modifierHashes: string[];
@@ -721,10 +721,10 @@ variants: IDestinyPublicMilestoneActivityVariant[];
 export interface IDestinyPublicMilestoneActivityVariant {
-    activityHash: string;
+    activityHash: number;
 }
 export interface IDestinyPublicMilestoneChallenge {
-    objectiveHash: string;
+    objectiveHash: number;
     activityHash?: string;
 }
 export interface IDestinyPublicMilestoneQuest {
-    questItemHash: string;
+    questItemHash: number;
     activity: IDestinyPublicMilestoneActivity;
@@ -738,4 +738,4 @@ challenges: IDestinyPublicMilestoneChallenge[];
 export interface IDestinyQuestStatus {
-    questHash: string;
-    stepHash: string;
+    questHash: number;
+    stepHash: number;
     stepObjectives: IDestinyObjectiveProgress[];
@@ -754,3 +754,3 @@ tracked: boolean;
 export interface IDestinyStat {
-    statHash: string;
+    statHash: number;
     value: number;
@@ -761,3 +761,3 @@ maximumValue: number;
     nodeIndex: number;
-    nodeHash: string;
+    nodeHash: number;
     state: DestinyTalentNodeState;
@@ -777,3 +777,3 @@ isActivated: boolean;
 export interface IDestinyUnlockStatus {
-    unlockHash: string;
+    unlockHash: number;
     isSet: boolean;
@@ -789,3 +789,3 @@ }
 export interface IDestinyVendorComponent {
-    vendorHash: string;
+    vendorHash: number;
     ackState: object;
@@ -804,3 +804,3 @@ nextRefreshDate: Date;
     itemReceived: IDestinyItemQuantity;
-    licenseUnlockHash: string;
+    licenseUnlockHash: number;
     purchasedByCharacterId: string;
@@ -831,3 +831,3 @@ refundPolicy: VendorItemRefundPolicy;
     vendorItemIndex: number;
-    itemHash: string;
+    itemHash: number;
     saleStatus: VendorItemStatus;
@@ -854,4 +854,4 @@ costs: IDestinyItemQuantity[];
 export interface IDyeReference {
-    channelHash: string;
-    dyeHash: string;
+    channelHash: number;
+    dyeHash: number;
 }
@@ -858,0 +858,0 @@ /**

package.json

 {
     "name": "the-traveler",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "description": "A Node.js API wrapper for the Destiny 2 API",
@@ -30,11 +30,14 @@ "keywords": [
         "posttest": "nyc report --reporter=lcov && codecov",
-        "doc": "typedoc --target ES5 --readme ./README.md --name 'The Traveler' --mode file --out ./docs/ --hideGenerator ./src/*.ts && touch ./docs/.nojekyll"
+        "doc": "typedoc --target ES5 --readme ./README.md --name 'The Traveler' --mode file --out ./docs/ --hideGenerator --exclude **/node_modules/** ./src/*.ts && touch ./docs/.nojekyll"
     },
     "dependencies": {
+        "@types/request-promise-native": "^1.0.6",
         "es6-promise": "^4.1.1",
         "request": "^2.81.0",
-        "request-promise-native": "^1.0.4",
-        "@types/request-promise-native": "^1.0.6"
+        "request-promise-native": "^1.0.4"
     },
     "devDependencies": {
+        "@types/chai": "^4.0.4",
+        "@types/chai-as-promised": "^7.1.0",
+        "@types/mocha": "^2.2.43",
         "babel-cli": "^6.26.0",
@@ -48,3 +51,2 @@ "babel-core": "^6.26.0",
         "codecov": "^2.3.0",
-        "es6-map": "^0.1.5",
         "es6-promise": "^4.1.1",
@@ -55,2 +57,4 @@ "es6-shim": "^0.35.3",
         "nyc": "^11.2.1",
+        "source-map-support": "^0.4.18",
+        "ts-node": "^3.3.0",
         "tslint": "^5.7.0",
@@ -60,2 +64,2 @@ "typedoc-clarity-theme": "^1.1.0",
     }
-}
+}

README.md

@@ -1,2 +0,2 @@
-# The Traveler
+# the-traveler 
 [![npm](https://img.shields.io/npm/v/the-traveler.svg)](https://www.npmjs.com/package/the-traveler)
@@ -9,3 +9,3 @@ [![npm](https://img.shields.io/npm/dt/the-traveler.svg)](https://www.npmjs.com/package/the-traveler)
 
-The Traveler is a small npm package which wraps around the Destiny 2 API. It uses Promises for a modern workflow in your application.
+the-traveler is a small npm package which wraps around the Destiny 2 API. It uses Promises for a modern workflow in your application.
 
@@ -15,3 +15,3 @@ Table of Contents
 
-   * [The Traveler](#the-traveler)
+   * [the-traveler](#the-traveler)
    * [Table of Contents](#table-of-contents)
@@ -51,3 +51,3 @@ * [Getting Started](#getting-started)
 
-To use this package you will need to obtain an API access key from the Bungie.net developer webiste. Please visit [https://www.bungie.net/en/Application](https://www.bungie.net/en/Application) to obtain your access token.
+To use this package you will need to obtain an API access key from the Bungie.net developer website. Please visit [https://www.bungie.net/en/Application](https://www.bungie.net/en/Application) to obtain your access token.
 
@@ -111,3 +111,3 @@ After obtaining your access token you are ready for using the Destiny 2 API in your next awesome project.
 ```
-const authUrl = traveler.traveler.generateOAuthURL(); // The URL your users have to visit to give your application access
+const authUrl = traveler.generateOAuthURL(); // The URL your users have to visit to give your application access
 ```
@@ -129,3 +129,3 @@
 
-The OAuth response schema is depended on the client type you are using on if you are using. With a `public` type the response does **not** contain an `refresh_token`. This means that a user has to authenticate everytime again after the OAuth access token has expired.
+The OAuth response schema is depended on the client type you are using. With a `public` type the response does **not** contain a `refresh_token`. This means that a user has to authenticate everytime again after the OAuth access token has expired.
 
@@ -141,3 +141,3 @@
 
-If you are using a `confidential` client type the response will contain a `refresh_token` which can be used to get a new `access_token` without requiring the user to approve your app again. Use this `refresh_token` to prevent getting errors if the `access_token` has expired.  In the following you can see such a response with the method to renew the token.
+If you are using a `confidential` client type the response will contain a `refresh_token` which can be used to get a new `access_token` without requiring the user to approve your app again. Use this `refresh_token` to prevent you from getting errors if the `access_token` has expired.  In the following you can see such a response with the method to renew the token.
 
@@ -156,3 +156,3 @@ _Response_:
 ```
-traveler.refreshToken(traveler.oauth.refresh_token).then(oauth => {
+traveler.refreshToken(traveler.oauth.refresh_token).then(oauth => { // take the refresh token from the oauth object you provided when initialize the oauth to the traveler
     // Provide your traveler object with the oauth object. This is later used for making authenticated calls
@@ -189,4 +189,2 @@ traveler.oauth = oauth;
 
-
-
 There are some other noteworthy information which could help to resolve some issues with the Destiny 2 API.
@@ -208,3 +206,3 @@
 
-Some information in the Destiny API is privacy protected. If the user set the pricacy settings it is not possible to obtain specific information through the API. The different pricacy indicators are the following:
+Some information in the Destiny API is privacy protected. If the user set the pricacy settings, and you do not use oauth for those users, it is not possible to obtain specific information through the API. The different pricacy indicators are the following:
 
@@ -251,3 +249,3 @@ * None: 0
 
-Here all character specific components are queried. You can either use normal strings or use the integrated enums for a better naming.
+Here all character specific components are queried. You can either use normal strings or use the integrated enums.
 
@@ -319,3 +317,3 @@ _Query:_
         characterId: 'yourCharacterId',
-        membershipType: Enums.BungieMembershipType.PSN
+        membershipType: BungieMembershipType.PSN // BungieMembershipType.PSN in ES5
     })
@@ -353,3 +351,3 @@ .then(result => {
 
-Please visit the [official documentation for the API](https://bungie-net.github.io/multi/operation_get_Destiny2-GetDestinyManifest.html#operation_get_Destiny2-GetDestinyManifest) to check if the endpoints are working or if they are still in preview. If you find endpoints in preview, please bear in mind that errors can occur quite often. If the endpoints get finalized also this package will adopt changes and test the functionalities.
+Please visit the [official documentation for the API](https://bungie-net.github.io/multi/operation_get_Destiny2-GetDestinyManifest.html#operation_get_Destiny2-GetDestinyManifest) to check if the endpoints are working or if they are still in preview. If you find endpoints in preview, please keep in mind that errors can occur quite often. If the endpoints get finalized also this package will adopt changes and test the functionalities.
 
@@ -394,3 +392,3 @@ | Endpoint                                  | Implemented      | Unlocked in API       |
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/alexanderwe/the-traveler/tags). 
+the-traveler uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/alexanderwe/the-traveler/tags). 
 
@@ -400,3 +398,3 @@
 
-Do you have any issues or recommendations for this package ? Feel free to open an issue in the [isse section](https://github.com/alexanderwe/the-traveler/issues) :) 
+Do you have any issues or recommendations for this package ? Feel free to open an issue in the [issue section](https://github.com/alexanderwe/the-traveler/issues) :) 
 
@@ -403,0 +401,0 @@

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

277618

increased by0.11%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

21

increased by23.53%

Lines of code

4860

decreased by-0.04%

Number of lines in readme file

400

decreased by-0.5%

No dependency changes