@taskeren/bungie-api-ts 5.10.0

package/tests/__snapshots__/config-builders.test.ts.snap

@@ -0,0 +1,343 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`check config builder for [Function awaGetActionToken] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Awa/GetActionToken/456734563673/",
+}
+`;
+
+exports[`check config builder for [Function awaInitializeRequest] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Awa/Initialize/",
+}
+`;
+
+exports[`check config builder for [Function awaProvideAuthorizationResult] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Awa/AwaProvideAuthorizationResult/",
+}
+`;
+
+exports[`check config builder for [Function equipItem] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/EquipItem/",
+}
+`;
+
+exports[`check config builder for [Function equipItems] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/EquipItems/",
+}
+`;
+
+exports[`check config builder for [Function getActivityHistory] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "count": "10",
+    "mode": "5",
+    "page": "2",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Account/123456/Character/1234658790/Stats/Activities/",
+}
+`;
+
+exports[`check config builder for [Function getCharacter] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/Character/1234658790/",
+}
+`;
+
+exports[`check config builder for [Function getClanAggregateStats] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "modes": [
+      5,
+      7,
+    ],
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/Stats/AggregateClanStats/78346592834756/",
+}
+`;
+
+exports[`check config builder for [Function getClanLeaderboards] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "maxtop": "6",
+    "modes": [
+      5,
+      7,
+    ],
+    "statid": "234624564",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/Stats/Leaderboards/Clans/78346592834756/",
+}
+`;
+
+exports[`check config builder for [Function getClanWeeklyRewardState] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Clan/78346592834756/WeeklyRewardState/",
+}
+`;
+
+exports[`check config builder for [Function getCollectibleNodeDetails] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/Character/1234658790/Collectibles/10293847/",
+}
+`;
+
+exports[`check config builder for [Function getDestinyAggregateActivityStats] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Account/123456/Character/1234658790/Stats/AggregateActivityStats/",
+}
+`;
+
+exports[`check config builder for [Function getDestinyEntityDefinition] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Manifest/DestinyInventoryItemDefinition/23463456/",
+}
+`;
+
+exports[`check config builder for [Function getDestinyManifest] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Manifest/",
+}
+`;
+
+exports[`check config builder for [Function getHistoricalStats] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "dayend": "YYYY-MM-DD",
+    "daystart": "YYYY-MM-DD",
+    "groups": "General,Weapons",
+    "modes": "5,7",
+    "periodType": "AllTime",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Account/123456/Character/1234658790/Stats/",
+}
+`;
+
+exports[`check config builder for [Function getHistoricalStatsDefinition] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Stats/Definition/",
+}
+`;
+
+exports[`check config builder for [Function getHistoricalStatsForAccount] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "groups": "General,Weapons",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Account/123456/Stats/",
+}
+`;
+
+exports[`check config builder for [Function getItem] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/Item/0987654321/",
+}
+`;
+
+exports[`check config builder for [Function getLeaderboards] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "maxtop": "6",
+    "modes": [
+      5,
+      7,
+    ],
+    "statid": "234624564",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Account/123456/Stats/Leaderboards/",
+}
+`;
+
+exports[`check config builder for [Function getLeaderboardsForCharacter] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "maxtop": "6",
+    "modes": [
+      5,
+      7,
+    ],
+    "statid": "234624564",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/Stats/Leaderboards/3/123456/1234658790/",
+}
+`;
+
+exports[`check config builder for [Function getLinkedProfiles] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "getAllMemberships": "true",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/LinkedProfiles/",
+}
+`;
+
+exports[`check config builder for [Function getPostGameCarnageReport] 1`] = `
+{
+  "method": "GET",
+  "url": "https://stats.bungie.net/Platform/Destiny2/Stats/PostGameCarnageReport/456745673456/",
+}
+`;
+
+exports[`check config builder for [Function getProfile] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/",
+}
+`;
+
+exports[`check config builder for [Function getPublicMilestoneContent] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Milestones/23546789/Content/",
+}
+`;
+
+exports[`check config builder for [Function getPublicMilestones] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/Milestones/",
+}
+`;
+
+exports[`check config builder for [Function getPublicVendors] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/Vendors/",
+}
+`;
+
+exports[`check config builder for [Function getUniqueWeaponHistory] 1`] = `
+{
+  "method": "GET",
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Account/123456/Character/1234658790/Stats/UniqueWeapons/",
+}
+`;
+
+exports[`check config builder for [Function getVendor] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/Character/1234658790/Vendors/45674576/",
+}
+`;
+
+exports[`check config builder for [Function getVendors] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "components": "400,402,300,301,304,305,306,307,600,308,310,309",
+    "filter": "0",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/3/Profile/123456/Character/1234658790/Vendors/",
+}
+`;
+
+exports[`check config builder for [Function insertSocketPlug] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/InsertSocketPlug/",
+}
+`;
+
+exports[`check config builder for [Function pullFromPostmaster] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/PullFromPostmaster/",
+}
+`;
+
+exports[`check config builder for [Function reportOffensivePostGameCarnageReportPlayer] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://stats.bungie.net/Platform/Destiny2/Stats/PostGameCarnageReport/456745673456/Report/",
+}
+`;
+
+exports[`check config builder for [Function searchDestinyEntities] 1`] = `
+{
+  "method": "GET",
+  "params": {
+    "page": "2",
+  },
+  "url": "https://www.bungie.net/Platform/Destiny2/Armory/Search/DestinyInventoryItemDefinition/something/",
+}
+`;
+
+exports[`check config builder for [Function searchDestinyPlayerByBungieName] 1`] = `
+{
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/SearchDestinyPlayerByBungieName/3/",
+}
+`;
+
+exports[`check config builder for [Function setItemLockState] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/SetLockState/",
+}
+`;
+
+exports[`check config builder for [Function setQuestTrackedState] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/SetTrackedState/",
+}
+`;
+
+exports[`check config builder for [Function transferItem] 1`] = `
+{
+  "body": {},
+  "method": "POST",
+  "url": "https://www.bungie.net/Platform/Destiny2/Actions/Items/TransferItem/",
+}
+`;

package/tests/config-builders.test.ts

@@ -0,0 +1,145 @@
+import {
+  getDestinyManifest,
+  getDestinyEntityDefinition,
+  getLinkedProfiles,
+  getProfile,
+  getCharacter,
+  getClanWeeklyRewardState,
+  getItem,
+  getVendors,
+  getVendor,
+  getPublicVendors,
+  getCollectibleNodeDetails,
+  transferItem,
+  pullFromPostmaster,
+  equipItem,
+  equipItems,
+  setItemLockState,
+  setQuestTrackedState,
+  insertSocketPlug,
+  getPostGameCarnageReport,
+  reportOffensivePostGameCarnageReportPlayer,
+  getHistoricalStatsDefinition,
+  getClanLeaderboards,
+  getClanAggregateStats,
+  getLeaderboards,
+  getLeaderboardsForCharacter,
+  searchDestinyEntities,
+  getHistoricalStats,
+  getHistoricalStatsForAccount,
+  getActivityHistory,
+  getUniqueWeaponHistory,
+  getDestinyAggregateActivityStats,
+  getPublicMilestoneContent,
+  getPublicMilestones,
+  awaInitializeRequest,
+  awaProvideAuthorizationResult,
+  awaGetActionToken,
+  searchDestinyPlayerByBungieName,
+} from '../generated-src/destiny2/api';
+import { HttpClient } from '../generated-src/http';
+import { DestinyComponentType } from '../generated-src/destiny2/interfaces';
+
+// instead of actually performing a fetch,
+// this fake HttpClient returns the HttpConfig it would have used to make the fetch
+// so we can check of the HttpConfig was built right
+const h = ((httpConfig?: any) => Promise.resolve(httpConfig)) as HttpClient;
+
+// sample values for the "body" argument
+const b = {} as any;
+
+// sample values for parameters
+const p = {
+  characterId: '1234658790',
+  components: [
+    DestinyComponentType.Vendors,
+    DestinyComponentType.VendorSales,
+    DestinyComponentType.ItemInstances,
+    DestinyComponentType.ItemObjectives,
+    DestinyComponentType.ItemStats,
+    DestinyComponentType.ItemSockets,
+    DestinyComponentType.ItemTalentGrids,
+    DestinyComponentType.ItemCommonData,
+    DestinyComponentType.CurrencyLookups,
+    DestinyComponentType.ItemPlugStates,
+    DestinyComponentType.ItemReusablePlugs,
+    DestinyComponentType.ItemPlugObjectives,
+  ],
+  destinyMembershipId: '123456',
+  getAllMemberships: true,
+  itemId: '0987654321',
+  itemInstanceId: '0987654321',
+  itemReferenceHash: 45674576,
+  membershipId: '123456',
+  membershipType: 3,
+  stackSize: 7,
+  transferToVault: true,
+  vendorHash: 45674576,
+  state: true,
+  groupId: '78346592834756',
+  correlationId: '456734563673',
+  count: 10,
+  mode: 5,
+  modes: [5, 7],
+  page: 2,
+  maxtop: 6,
+  statid: '234624564',
+  returnOriginalProfile: true,
+  displayName: 'asdf',
+  entityType: 'DestinyInventoryItemDefinition',
+  hashIdentifier: 23463456,
+  dayend: 'YYYY-MM-DD',
+  daystart: 'YYYY-MM-DD',
+  groups: ['General', 'Weapons'],
+  periodType: 'AllTime',
+  milestoneHash: 23546789,
+  collectiblePresentationNodeHash: 10293847,
+  activityId: '456745673456',
+  filter: 0,
+  type: 'DestinyInventoryItemDefinition',
+  searchTerm: 'something',
+};
+
+const testCases: [(..._: any) => any, any[]][] = [
+  [getDestinyManifest, [h]],
+  [getDestinyEntityDefinition, [h, p]],
+  [searchDestinyPlayerByBungieName, [h, p]],
+  [getLinkedProfiles, [h, p]],
+  [getProfile, [h, p]],
+  [getCharacter, [h, p]],
+  [getClanWeeklyRewardState, [h, p]],
+  [getItem, [h, p]],
+  [getVendors, [h, p]],
+  [getVendor, [h, p]],
+  [getPublicVendors, [h, p]],
+  [getCollectibleNodeDetails, [h, p]],
+  [transferItem, [h, b]],
+  [pullFromPostmaster, [h, b]],
+  [equipItem, [h, b]],
+  [equipItems, [h, b]],
+  [setItemLockState, [h, b]],
+  [setQuestTrackedState, [h, b]],
+  [insertSocketPlug, [h, b]],
+  [getPostGameCarnageReport, [h, p]],
+  [reportOffensivePostGameCarnageReportPlayer, [h, p, b]],
+  [getHistoricalStatsDefinition, [h]],
+  [getClanLeaderboards, [h, p]],
+  [getClanAggregateStats, [h, p]],
+  [getLeaderboards, [h, p]],
+  [getLeaderboardsForCharacter, [h, p]],
+  [searchDestinyEntities, [h, p]],
+  [getHistoricalStats, [h, p]],
+  [getHistoricalStatsForAccount, [h, p]],
+  [getActivityHistory, [h, p]],
+  [getUniqueWeaponHistory, [h, p]],
+  [getDestinyAggregateActivityStats, [h, p]],
+  [getPublicMilestoneContent, [h, p]],
+  [getPublicMilestones, [h]],
+  [awaInitializeRequest, [h, b]],
+  [awaProvideAuthorizationResult, [h, b]],
+  [awaGetActionToken, [h, p]],
+];
+
+test.each(testCases)('check config builder for %p', async (func, args) => {
+  expect(await func(...args)).toMatchSnapshot();
+});

package/tests/manifest-fetcher.test.ts

@@ -0,0 +1,43 @@
+import { getDestinyManifest } from '../generated-src/destiny2/api';
+import { getDestinyManifestSlice } from '../generated-src/destiny2/manifest';
+import { HttpClientConfig } from '../generated-src/http';
+
+async function httpClient(config: HttpClientConfig) {
+  return (fetch as any)(config.url, config)
+    .then((res: Response) => res.json())
+    .catch((e: any) => {
+      console.log('DESTINY API ERROR');
+      console.log('probably about to fail a promise here. sorry.');
+      console.log(console.log(e));
+    });
+}
+
+test('manifest downloads and getDestinyManifestSlice contains 2 tables', async () => {
+  const manifestMetadata = (await getDestinyManifest(httpClient)).Response;
+
+  const partialManifest = await getDestinyManifestSlice(httpClient, {
+    destinyManifest: manifestMetadata,
+    tableNames: ['DestinyInventoryItemDefinition', 'DestinyLocationDefinition'],
+    language: 'en',
+  });
+
+  expect(Object.keys(partialManifest)).toMatchInlineSnapshot(`
+    [
+      "DestinyInventoryItemDefinition",
+      "DestinyLocationDefinition",
+    ]
+  `);
+
+  // const items = partialManifest.DestinyInventoryItemDefinition;
+  // const locations = partialManifest.DestinyLocationDefinition;
+  // maybe this is overkill
+  // expect(
+  //   Object.values(items).filter((i) => (i as any).vendorHash || (i as any).locationReleases)
+  // ).toHaveLength(0);
+
+  // expect(
+  //   Object.values(locations).filter(
+  //     (l) => (l as any).itemTypeAndTierDisplayName || (l as any).damageTypeHashes
+  //   )
+  // ).toHaveLength(0);
+});

package/tests/test-manifest.js

@@ -0,0 +1,69 @@
+import { getDestinyManifest } from '../lib/destiny2/index.js';
+import { getDestinyManifestSlice } from '../lib/destiny2/manifest.js';
+async function httpClient(config) {
+  return fetch(config.url, config)
+    .then((res) => res.json())
+    .catch((e) => {
+      console.log('DESTINY API ERROR');
+      console.log('probably about to fail a promise here. sorry.');
+      console.log(console.log(e));
+    });
+}
+(async () => {
+  var _a, _b, _c, _d, _e;
+  const manifestMeta = (await getDestinyManifest(httpClient)).Response;
+  // const manifestTable = await getDestinyManifestComponent(httpClient, {
+  //   destinyManifest: manifestMeta,
+  //   tableName: 'DestinyInventoryItemDefinition',
+  //   language: 'en',
+  // });
+  const partialManifest = await getDestinyManifestSlice(httpClient, {
+    destinyManifest: manifestMeta,
+    tableNames: ['DestinyInventoryItemDefinition', 'DestinyLocationDefinition'],
+    language: 'en',
+  });
+  const items = partialManifest.DestinyInventoryItemDefinition;
+  const locations = partialManifest.DestinyLocationDefinition;
+  // grab a gun we know
+  const betterDevils =
+    (_c =
+      (_b = (_a = items[1048266744]) !== null && _a !== void 0 ? _a : items[153979397]) !== null &&
+      _b !== void 0
+        ? _b
+        : Object.values(items).find((i) => {
+            var _a, _b;
+            return (
+              ((_b = (_a = i.displayProperties) === null || _a === void 0 ? void 0 : _a.name) ===
+                null || _b === void 0
+                ? void 0
+                : _b.toLowerCase()) === 'better devils'
+            );
+          })) !== null && _c !== void 0
+      ? _c
+      : {};
+  // ensure it has attributes we expect and not attributes from another table
+  const betterDevilsTests =
+    betterDevils.itemTypeAndTierDisplayName !== undefined &&
+    betterDevils.inventory &&
+    betterDevils.damageTypeHashes &&
+    betterDevils.itemCategoryHashes &&
+    !betterDevils.vendorHash &&
+    !betterDevils.locationReleases;
+  const exampleLocation =
+    (_e =
+      (_d = locations[337241121]) !== null && _d !== void 0 ? _d : Object.values(locations)[0]) !==
+      null && _e !== void 0
+      ? _e
+      : {};
+  const locationTests =
+    exampleLocation.vendorHash !== undefined &&
+    exampleLocation.hash !== undefined &&
+    exampleLocation.locationReleases &&
+    !exampleLocation.itemTypeAndTierDisplayName &&
+    !exampleLocation.damageTypeHashes;
+  if (!betterDevilsTests || !locationTests) {
+    !betterDevilsTests && console.log('betterDevilsTests failed. unexpected data:', betterDevils);
+    !locationTests && console.log('locationTests failed. unexpected data:', exampleLocation);
+    process.exit(1);
+  } else console.log('tests passed'); // manifest downloader worked and expected attributes were present
+})();

package/tsconfig-package.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "outDir": "./lib/",
+    "sourceMap": false,
+    "strictNullChecks": true,
+    "module": "ES2015",
+    "target": "es5",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "esModuleInterop": true
+  },
+  "include": ["./generated-src/**/*"]
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "rootDir": "./generator",
+    "outDir": "./build/",
+    "sourceMap": true,
+    "strictNullChecks": true,
+    "strict": true,
+    "module": "NodeNext",
+    "target": "ESNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "preserveConstEnums": true
+  },
+  "include": ["./generator/**/*"]
+}