@taskeren/bungie-api-ts 5.10.1 → 5.10.3

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@taskeren/bungie-api-ts",
-  "version": "5.10.1",
+  "version": "5.10.3",
   "description": "TypeScript mappings for the Bungie.net API",
   "type": "module",
   "sideEffects": false,
+  "scripts": {},
   "jest": {
     "preset": "ts-jest/presets/js-with-babel-esm",
     "testEnvironment": "node",
@@ -30,31 +31,69 @@
     "TypeScript"
   ],
   "homepage": "https://github.com/DestinyItemManager/bungie-api-ts",
-  "devDependencies": {
-    "@babel/cli": "^7.16.0",
-    "@babel/core": "^7.16.0",
-    "@babel/preset-env": "^7.16.4",
-    "@babel/preset-typescript": "^7.16.0",
-    "@types/jest": "^29.2.4",
-    "@types/lodash": "^4.14.191",
-    "@types/node": "^18.11.13",
-    "@types/node-fetch": "^2.6.2",
-    "@types/underscore": "^1.11.3",
-    "babel-jest": "^29.3.1",
-    "jest": "^29.3.1",
-    "lodash": "^4.17.21",
-    "mkdirp": "^2.1.3",
-    "openapi3-ts": "^2.0.1",
-    "prettier": "^2.8.1",
-    "ts-jest": "^29.0.3",
-    "typescript": "^5.7.3"
-  },
+  "devDependencies": {},
   "packageManager": "pnpm@8.15.9+sha512.499434c9d8fdd1a2794ebf4552b3b25c0a633abcee5bb15e7b5de90f32f47b513aca98cd5cfd001c31f0db454bc3804edccd578501e4ca293a6816166bbd9f81",
-  "scripts": {
-    "tsc": "tsc",
-    "start": "sh ./build.sh",
-    "submodule": "git submodule init && git submodule update",
-    "updatespec": "git submodule update --remote --merge",
-    "test": "jest"
-  }
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "default": "./index.js",
+      "types": "./index.d.ts"
+    },
+    "./http": {
+      "default": "./http.js",
+      "types": "./http.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./app": {
+      "default": "./app/index.js",
+      "types": "./app/index.d.ts"
+    },
+    "./user": {
+      "default": "./user/index.js",
+      "types": "./user/index.d.ts"
+    },
+    "./content": {
+      "default": "./content/index.js",
+      "types": "./content/index.d.ts"
+    },
+    "./forum": {
+      "default": "./forum/index.js",
+      "types": "./forum/index.d.ts"
+    },
+    "./groupv2": {
+      "default": "./groupv2/index.js",
+      "types": "./groupv2/index.d.ts"
+    },
+    "./tokens": {
+      "default": "./tokens/index.js",
+      "types": "./tokens/index.d.ts"
+    },
+    "./destiny2": {
+      "default": "./destiny2/index.js",
+      "types": "./destiny2/index.d.ts"
+    },
+    "./communitycontent": {
+      "default": "./communitycontent/index.js",
+      "types": "./communitycontent/index.d.ts"
+    },
+    "./trending": {
+      "default": "./trending/index.js",
+      "types": "./trending/index.d.ts"
+    },
+    "./fireteam": {
+      "default": "./fireteam/index.js",
+      "types": "./fireteam/index.d.ts"
+    },
+    "./social": {
+      "default": "./social/index.js",
+      "types": "./social/index.d.ts"
+    },
+    "./core": {
+      "default": "./core/index.js",
+      "types": "./core/index.d.ts"
+    }
+  },
+  "dependencies": {}
 }

package/{lib/platform.d.ts → platform.d.ts}

@@ -21,15 +21,16 @@ export interface IgnoreResponse {
  * This enum represents a set of flags - use bitwise operators to check which of
  * these match your value.
  */
-export declare const enum IgnoreStatus {
-    NotIgnored = 0,
-    IgnoredUser = 1,
-    IgnoredGroup = 2,
-    IgnoredByGroup = 4,
-    IgnoredPost = 8,
-    IgnoredTag = 16,
-    IgnoredGlobal = 32
-}
+export declare const IgnoreStatus: {
+    readonly NotIgnored: 0;
+    readonly IgnoredUser: 1;
+    readonly IgnoredGroup: 2;
+    readonly IgnoredByGroup: 4;
+    readonly IgnoredPost: 8;
+    readonly IgnoredTag: 16;
+    readonly IgnoredGlobal: 32;
+};
+export type IgnoreStatus = typeof IgnoreStatus[keyof typeof IgnoreStatus];
 export interface TagResponse {
     readonly tagText: string;
     readonly ignoreStatus: IgnoreResponse;

package/{lib/platform.js → platform.js}

@@ -1,4 +1,4 @@
-export var IgnoreStatus = {
+export const IgnoreStatus = {
   NotIgnored: 0,
   IgnoredUser: 1,
   IgnoredGroup: 2,

package/{lib/social → social}/interfaces.d.ts

@@ -11,13 +11,14 @@
  */
 import { BungieMembershipType } from '../common.js';
 import { GeneralUser } from '../user/interfaces.js';
-export declare const enum PlatformFriendType {
-  Unknown = 0,
-  Xbox = 1,
-  PSN = 2,
-  Steam = 3,
-  Egs = 4,
-}
+export declare const PlatformFriendType: {
+  readonly Unknown: 0;
+  readonly Xbox: 1;
+  readonly PSN: 2;
+  readonly Steam: 3;
+  readonly Egs: 4;
+};
+export type PlatformFriendType = (typeof PlatformFriendType)[keyof typeof PlatformFriendType];
 export interface BungieFriendListResponse {
   readonly friends: BungieFriend[];
 }
@@ -35,25 +36,30 @@ export interface BungieFriend {
   readonly relationship: FriendRelationshipState;
   readonly bungieNetUser: GeneralUser;
 }
-export declare const enum PresenceStatus {
-  OfflineOrUnknown = 0,
-  Online = 1,
-}
+export declare const PresenceStatus: {
+  readonly OfflineOrUnknown: 0;
+  readonly Online: 1;
+};
+export type PresenceStatus = (typeof PresenceStatus)[keyof typeof PresenceStatus];
 /**
  * This enum represents a set of flags - use bitwise operators to check which of
  * these match your value.
  */
-export declare const enum PresenceOnlineStateFlags {
-  None = 0,
-  Destiny1 = 1,
-  Destiny2 = 2,
-}
-export declare const enum FriendRelationshipState {
-  Unknown = 0,
-  Friend = 1,
-  IncomingRequest = 2,
-  OutgoingRequest = 3,
-}
+export declare const PresenceOnlineStateFlags: {
+  readonly None: 0;
+  readonly Destiny1: 1;
+  readonly Destiny2: 2;
+};
+export type PresenceOnlineStateFlags =
+  (typeof PresenceOnlineStateFlags)[keyof typeof PresenceOnlineStateFlags];
+export declare const FriendRelationshipState: {
+  readonly Unknown: 0;
+  readonly Friend: 1;
+  readonly IncomingRequest: 2;
+  readonly OutgoingRequest: 3;
+};
+export type FriendRelationshipState =
+  (typeof FriendRelationshipState)[keyof typeof FriendRelationshipState];
 export interface BungieFriendRequestListResponse {
   readonly incomingRequests: BungieFriend[];
   readonly outgoingRequests: BungieFriend[];

package/{lib/social → social}/interfaces.js

@@ -1,20 +1,20 @@
-export var PlatformFriendType = {
+export const PlatformFriendType = {
   Unknown: 0,
   Xbox: 1,
   PSN: 2,
   Steam: 3,
   Egs: 4,
 };
-export var PresenceStatus = {
+export const PresenceStatus = {
   OfflineOrUnknown: 0,
   Online: 1,
 };
-export var PresenceOnlineStateFlags = {
+export const PresenceOnlineStateFlags = {
   None: 0,
   Destiny1: 1,
   Destiny2: 2,
 };
-export var FriendRelationshipState = {
+export const FriendRelationshipState = {
   Unknown: 0,
   Friend: 1,
   IncomingRequest: 2,

package/{lib/tokens → tokens}/interfaces.d.ts

@@ -49,11 +49,12 @@ export interface TwitchDropHistoryResponse {
   readonly CreatedAt?: string;
   readonly ClaimState?: DropStateEnum;
 }
-export declare const enum DropStateEnum {
-  Claimed = 0,
-  Applied = 1,
-  Fulfilled = 2,
-}
+export declare const DropStateEnum: {
+  readonly Claimed: 0;
+  readonly Applied: 1;
+  readonly Fulfilled: 2;
+};
+export type DropStateEnum = (typeof DropStateEnum)[keyof typeof DropStateEnum];
 export interface BungieRewardDisplay {
   readonly UserRewardAvailabilityModel: UserRewardAvailabilityModel;
   readonly ObjectiveDisplayProperties: RewardDisplayProperties;

package/{lib/tokens → tokens}/interfaces.js

@@ -1,4 +1,4 @@
-export var DropStateEnum = {
+export const DropStateEnum = {
   Claimed: 0,
   Applied: 1,
   Fulfilled: 2,

package/{lib/trending → trending}/interfaces.d.ts

@@ -17,20 +17,21 @@ import {
 } from '../destiny2/interfaces.js';
 import { PagedQuery } from '../common.js';
 /** The known entity types that you can have returned from Trending. */
-export declare const enum TrendingEntryType {
-  News = 0,
-  DestinyItem = 1,
-  DestinyActivity = 2,
-  DestinyRitual = 3,
-  SupportArticle = 4,
-  Creation = 5,
-  Stream = 6,
-  Update = 7,
-  Link = 8,
-  ForumTag = 9,
-  Container = 10,
-  Release = 11,
-}
+export declare const TrendingEntryType: {
+  readonly News: 0;
+  readonly DestinyItem: 1;
+  readonly DestinyActivity: 2;
+  readonly DestinyRitual: 3;
+  readonly SupportArticle: 4;
+  readonly Creation: 5;
+  readonly Stream: 6;
+  readonly Update: 7;
+  readonly Link: 8;
+  readonly ForumTag: 9;
+  readonly Container: 10;
+  readonly Release: 11;
+};
+export type TrendingEntryType = (typeof TrendingEntryType)[keyof typeof TrendingEntryType];
 export interface TrendingCategories {
   readonly categories: TrendingCategory[];
 }

package/{lib/trending → trending}/interfaces.js

@@ -1,4 +1,4 @@
-export var TrendingEntryType = {
+export const TrendingEntryType = {
   News: 0,
   DestinyItem: 1,
   DestinyActivity: 2,

package/{lib/user → user}/interfaces.d.ts

@@ -63,22 +63,23 @@ export interface UserInfoCard {
  * facing enum used in place of the internal-only Bungie.SharedDefinitions.
  * CredentialType.
  */
-export declare const enum BungieCredentialType {
-  None = 0,
-  Xuid = 1,
-  Psnid = 2,
-  Wlid = 3,
-  Fake = 4,
-  Facebook = 5,
-  Google = 8,
-  Windows = 9,
-  DemonId = 10,
-  SteamId = 12,
-  BattleNetId = 14,
-  StadiaId = 16,
-  TwitchId = 18,
-  EgsId = 20,
-}
+export declare const BungieCredentialType: {
+  readonly None: 0;
+  readonly Xuid: 1;
+  readonly Psnid: 2;
+  readonly Wlid: 3;
+  readonly Fake: 4;
+  readonly Facebook: 5;
+  readonly Google: 8;
+  readonly Windows: 9;
+  readonly DemonId: 10;
+  readonly SteamId: 12;
+  readonly BattleNetId: 14;
+  readonly StadiaId: 16;
+  readonly TwitchId: 18;
+  readonly EgsId: 20;
+};
+export type BungieCredentialType = (typeof BungieCredentialType)[keyof typeof BungieCredentialType];
 export interface UserSearchPrefixRequest {
   readonly displayNamePrefix: string;
 }
@@ -237,18 +238,19 @@ export interface EmailOptInDefinition {
  * This enum represents a set of flags - use bitwise operators to check which of
  * these match your value.
  */
-export declare const enum OptInFlags {
-  None = 0,
-  Newsletter = 1,
-  System = 2,
-  Marketing = 4,
-  UserResearch = 8,
-  CustomerService = 16,
-  Social = 32,
-  PlayTests = 64,
-  PlayTestsLocal = 128,
-  Careers = 256,
-}
+export declare const OptInFlags: {
+  readonly None: 0;
+  readonly Newsletter: 1;
+  readonly System: 2;
+  readonly Marketing: 4;
+  readonly UserResearch: 8;
+  readonly CustomerService: 16;
+  readonly Social: 32;
+  readonly PlayTests: 64;
+  readonly PlayTestsLocal: 128;
+  readonly Careers: 256;
+};
+export type OptInFlags = (typeof OptInFlags)[keyof typeof OptInFlags];
 /**
  * Defines a single subscription: permission to send emails for a specific, focused
  * subject (generally timeboxed, such as for a specific release of a product or

package/{lib/user → user}/interfaces.js

@@ -1,4 +1,4 @@
-export var BungieCredentialType = {
+export const BungieCredentialType = {
   None: 0,
   Xuid: 1,
   Psnid: 2,
@@ -14,7 +14,7 @@ export var BungieCredentialType = {
   TwitchId: 18,
   EgsId: 20,
 };
-export var OptInFlags = {
+export const OptInFlags = {
   None: 0,
   Newsletter: 1,
   System: 2,

package/.babelrc

@@ -1,4 +0,0 @@
-{
-  "comments": false,
-  "presets": [["@babel/preset-typescript", { "optimizeConstEnums": true }]]
-}

package/.gitattributes

@@ -1,2 +0,0 @@
-# Generated files can always be collapsed in diffs
-lib/ linguist-generated

package/.github/workflows/pr-build.yml

@@ -1,50 +0,0 @@
-name: PR Build
-
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-
-# Ensures that only one deploy task per branch/environment will run at a time.
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - uses: pnpm/action-setup@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: pnpm
-
-      - name: Install
-        run: pnpm install --frozen-lockfile --prefer-offline
-
-      - name: Build
-        run: pnpm start
-
-      - name: porcelain check
-        uses: dorny/paths-filter@v2
-        id: filter
-        with:
-          base: HEAD
-          filters: |
-            changed:
-              - '**'
-
-      - name: Fail if modified files
-        if: steps.filter.outputs.changed == 'true'
-        run: |
-          echo "::error title=Built files not checked in::Make sure to run pnpm start and check in modified files"
-          exit 1
-
-      - name: Test
-        run: pnpm test

package/.github/workflows/publish.yml

@@ -1,48 +0,0 @@
-name: NPM Publish
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  publish:
-    environment: publish
-    permissions:
-      contents: read
-      id-token: write
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v5
-        with:
-          submodules: recursive
-
-      # This will only publish if the package.json version has changed
-      - name: Check version changes
-        uses: EndBug/version-check@v2 # More info about the arguments on the action page
-        id: check # This will be the reference for later
-        with:
-          file-url: https://unpkg.com/bungie-api-ts@latest/package.json
-          static-checking: localIsNew
-      
-      - name: pnpm setup
-        if: steps.check.outputs.changed == 'true'
-        uses: pnpm/action-setup@v4
-
-      - name: Setup Node
-        if: steps.check.outputs.changed == 'true'
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: '.nvmrc'
-          registry-url: https://registry.npmjs.org/
-
-      - name: Install
-        if: steps.check.outputs.changed == 'true'
-        run: pnpm install --frozen-lockfile --prefer-offline
-
-      - name: Publish the package to NPM
-        if: steps.check.outputs.changed == 'true'
-        run: |
-          cd lib
-          npm install -g npm@latest
-          npm publish --access public --provenance

package/.github/workflows/update.yml

@@ -1,55 +0,0 @@
-name: Update API sources
-
-on:
-  # Can be manually triggered
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - name: Update submodules
-        run: |
-          git submodule update --init --recursive
-          git submodule update --recursive --remote
-
-      - name: Check for changes
-        uses: dorny/paths-filter@v2
-        id: filter
-        with:
-          base: HEAD
-          filters: |
-            changed:
-              - '**'
-
-      - uses: pnpm/action-setup@v4
-
-      - name: Setup Node
-        if: steps.filter.outputs.changed == 'true'
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: pnpm
-
-      - name: Install
-        if: steps.filter.outputs.changed == 'true'
-        run: pnpm install --frozen-lockfile --prefer-offline
-
-      - name: Bump version
-        if: steps.filter.outputs.changed == 'true'
-        run: npm version minor --no-git-tag-version
-
-      - name: Build
-        if: steps.filter.outputs.changed == 'true'
-        run: pnpm start
-
-      - name: Create Pull Request
-        if: steps.filter.outputs.changed == 'true'
-        uses: peter-evans/create-pull-request@v4
-        with:
-          title: 'Updated api-src'
-          commit-message: 'Updated api-src'

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "api-src"]
-	path = api-src
-	url = https://github.com/Bungie-net/api

package/.nvmrc

@@ -1 +0,0 @@
-22

package/.prettierrc

@@ -1,10 +0,0 @@
-{
-  "printWidth": 100,
-  "singleQuote": true,
-  "arrowParens": "always",
-  "overrides": [
-    {
-      "files": "*.html"
-    }
-  ]
-}

package/.vscode/extensions.json

@@ -1,8 +0,0 @@
-{
-  // See http://go.microsoft.com/fwlink/?LinkId=827846
-  // for the documentation about the extensions.json format
-  "recommendations": [
-    // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
-    "esbenp.prettier-vscode"
-  ]
-}

package/.vscode/settings.json

@@ -1,7 +0,0 @@
-{
-  "editor.tabSize": 2,
-  "editor.trimAutoWhitespace": true,
-  "files.trimTrailingWhitespace": true,
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "editor.formatOnSave": true
-}

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Destiny Item Manager
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/api-src/.github/workflows/close-inactive.yml

@@ -1,24 +0,0 @@
-name: Close inactive issues
-on:
-  schedule:
-    - cron: "0 8 * * *"
-
-jobs:
-  close-issues:
-    name: Close Stale Issues
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-    steps:
-      - uses: actions/stale@v5
-        with:
-          days-before-issue-stale: 365
-          days-before-issue-close: 7
-          stale-issue-label: "stale"
-          stale-issue-message: ""
-          close-issue-message: "This issue was closed because it has been inactive for one week since being marked as stale."
-          days-before-pr-stale: -1
-          days-before-pr-close: -1
-          operations-per-run: 50
-          repo-token: ${{ secrets.GITHUB_TOKEN }}