@taskeren/bungie-api-ts 5.10.0

package/lib/groupv2/interfaces.js

@@ -0,0 +1,100 @@
+export var GroupType = {
+  General: 0,
+  Clan: 1,
+};
+export var ChatSecuritySetting = {
+  Group: 0,
+  Admins: 1,
+};
+export var GroupHomepage = {
+  Wall: 0,
+  Forum: 1,
+  AllianceForum: 2,
+};
+export var MembershipOption = {
+  Reviewed: 0,
+  Open: 1,
+  Closed: 2,
+};
+export var GroupPostPublicity = {
+  Public: 0,
+  Alliance: 1,
+  Private: 2,
+};
+export var Capabilities = {
+  None: 0,
+  Leaderboards: 1,
+  Callsign: 2,
+  OptionalConversations: 4,
+  ClanBanner: 8,
+  D2InvestmentData: 16,
+  Tags: 32,
+  Alliances: 64,
+};
+export var HostGuidedGamesPermissionLevel = {
+  None: 0,
+  Beginner: 1,
+  Member: 2,
+};
+export var RuntimeGroupMemberType = {
+  None: 0,
+  Beginner: 1,
+  Member: 2,
+  Admin: 3,
+  ActingFounder: 4,
+  Founder: 5,
+};
+export var GroupAllianceStatus = {
+  Unallied: 0,
+  Parent: 1,
+  Child: 2,
+};
+export var GroupPotentialMemberStatus = {
+  None: 0,
+  Applicant: 1,
+  Invitee: 2,
+};
+export var GroupDateRange = {
+  All: 0,
+  PastDay: 1,
+  PastWeek: 2,
+  PastMonth: 3,
+  PastYear: 4,
+};
+export var GroupsForMemberFilter = {
+  All: 0,
+  Founded: 1,
+  NonFounded: 2,
+};
+export var GroupSortBy = {
+  Name: 0,
+  Date: 1,
+  Popularity: 2,
+  Id: 3,
+};
+export var GroupMemberCountFilter = {
+  All: 0,
+  OneToTen: 1,
+  ElevenToOneHundred: 2,
+  GreaterThanOneHundred: 3,
+};
+export var IgnoreLength = {
+  None: 0,
+  Week: 1,
+  TwoWeeks: 2,
+  ThreeWeeks: 3,
+  Month: 4,
+  ThreeMonths: 5,
+  SixMonths: 6,
+  Year: 7,
+  Forever: 8,
+  ThreeMinutes: 9,
+  Hour: 10,
+  ThirtyDays: 11,
+};
+export var GroupApplicationResolveState = {
+  Unresolved: 0,
+  Accepted: 1,
+  Denied: 2,
+  Rescinded: 3,
+};

package/lib/http.d.ts

@@ -0,0 +1,18 @@
+export type HttpQueryParams = Record<string, string>;
+export interface HttpClientConfig {
+    method: 'GET' | 'POST';
+    url: string;
+    /** Query string params */
+    params?: HttpQueryParams;
+    /** Request body */
+    body?: any;
+}
+/**
+ * A generic, minimal type for providing an HTTP client function.
+ * This gets the necessary config provided as an argument, and then
+ * should produce a promise for the parsed JSON as a result. The API
+ * helper functions will use this to return the right type.
+ */
+export type HttpClient = <Return>(config: HttpClientConfig) => Promise<Return>;
+export declare function get<Return>(http: HttpClient, url: string, params?: HttpQueryParams): Promise<Return>;
+export declare function post<Return>(http: HttpClient, url: string, body?: any): Promise<Return>;

package/lib/http.js

@@ -0,0 +1,20 @@
+export function get(http, url, params) {
+  return http(params ? {
+    method: 'GET',
+    url,
+    params
+  } : {
+    method: 'GET',
+    url
+  });
+}
+export function post(http, url, body) {
+  return http(body ? {
+    method: 'POST',
+    url,
+    body
+  } : {
+    method: 'POST',
+    url
+  });
+}

package/lib/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+import * as AppImport from './app/index.js';
+import * as UserImport from './user/index.js';
+import * as ContentImport from './content/index.js';
+import * as ForumImport from './forum/index.js';
+import * as GroupV2Import from './groupv2/index.js';
+import * as TokensImport from './tokens/index.js';
+import * as Destiny2Import from './destiny2/index.js';
+import * as CommunityContentImport from './communitycontent/index.js';
+import * as TrendingImport from './trending/index.js';
+import * as FireteamImport from './fireteam/index.js';
+import * as SocialImport from './social/index.js';
+import * as CoreImport from './core/index.js';
+export declare const App: typeof AppImport;
+export declare const User: typeof UserImport;
+export declare const Content: typeof ContentImport;
+export declare const Forum: typeof ForumImport;
+export declare const GroupV2: typeof GroupV2Import;
+export declare const Tokens: typeof TokensImport;
+export declare const Destiny2: typeof Destiny2Import;
+export declare const CommunityContent: typeof CommunityContentImport;
+export declare const Trending: typeof TrendingImport;
+export declare const Fireteam: typeof FireteamImport;
+export declare const Social: typeof SocialImport;
+export declare const Core: typeof CoreImport;

package/lib/index.js

@@ -0,0 +1,24 @@
+import * as AppImport from './app/index.js';
+import * as UserImport from './user/index.js';
+import * as ContentImport from './content/index.js';
+import * as ForumImport from './forum/index.js';
+import * as GroupV2Import from './groupv2/index.js';
+import * as TokensImport from './tokens/index.js';
+import * as Destiny2Import from './destiny2/index.js';
+import * as CommunityContentImport from './communitycontent/index.js';
+import * as TrendingImport from './trending/index.js';
+import * as FireteamImport from './fireteam/index.js';
+import * as SocialImport from './social/index.js';
+import * as CoreImport from './core/index.js';
+export const App = AppImport;
+export const User = UserImport;
+export const Content = ContentImport;
+export const Forum = ForumImport;
+export const GroupV2 = GroupV2Import;
+export const Tokens = TokensImport;
+export const Destiny2 = Destiny2Import;
+export const CommunityContent = CommunityContentImport;
+export const Trending = TrendingImport;
+export const Fireteam = FireteamImport;
+export const Social = SocialImport;
+export const Core = CoreImport;

package/lib/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "bungie-api-ts",
+  "version": "5.10.0",
+  "description": "TypeScript mappings for the Bungie.net API",
+  "type": "module",
+  "sideEffects": false,
+  "scripts": {},
+  "jest": {
+    "preset": "ts-jest/presets/js-with-babel-esm",
+    "testEnvironment": "node",
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    }
+  },
+  "engines": {
+    "node": ">=13.2.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DestinyItemManager/bungie-api-ts.git"
+  },
+  "author": "Ben Hollis",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/DestinyItemManager/bungie-api-ts/issues"
+  },
+  "keywords": [
+    "Destiny",
+    "Bungie",
+    "Bungie.net",
+    "TypeScript"
+  ],
+  "homepage": "https://github.com/DestinyItemManager/bungie-api-ts",
+  "devDependencies": {},
+  "packageManager": "pnpm@8.15.9+sha512.499434c9d8fdd1a2794ebf4552b3b25c0a633abcee5bb15e7b5de90f32f47b513aca98cd5cfd001c31f0db454bc3804edccd578501e4ca293a6816166bbd9f81",
+  "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

@@ -0,0 +1,36 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+export interface IgnoreResponse {
+    readonly isIgnored: boolean;
+    /**
+     * This enum represents a set of flags - use bitwise operators to check which of
+     * these match your value.
+     */
+    readonly ignoreFlags: IgnoreStatus;
+}
+/**
+ * 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 interface TagResponse {
+    readonly tagText: string;
+    readonly ignoreStatus: IgnoreResponse;
+}

package/lib/platform.js

@@ -0,0 +1,9 @@
+export var IgnoreStatus = {
+  NotIgnored: 0,
+  IgnoredUser: 1,
+  IgnoredGroup: 2,
+  IgnoredByGroup: 4,
+  IgnoredPost: 8,
+  IgnoredTag: 16,
+  IgnoredGlobal: 32
+};

package/lib/social/api.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+import { HttpClient } from '../http.js';
+import {
+  BungieFriendListResponse,
+  BungieFriendRequestListResponse,
+  PlatformFriendResponse,
+  PlatformFriendType,
+} from './interfaces.js';
+import { ServerResponse } from '../common.js';
+/** Returns your Bungie Friend list */
+export declare function getFriendList(
+  http: HttpClient
+): Promise<ServerResponse<BungieFriendListResponse>>;
+/** Returns your friend request queue. */
+export declare function getFriendRequestList(
+  http: HttpClient
+): Promise<ServerResponse<BungieFriendRequestListResponse>>;
+export interface IssueFriendRequestParams {
+  /** The membership id of the user you wish to add. */
+  membershipId: string;
+}
+/**
+ * Requests a friend relationship with the target user. Any of the target user's
+ * linked membership ids are valid inputs.
+ */
+export declare function issueFriendRequest(
+  http: HttpClient,
+  params: IssueFriendRequestParams
+): Promise<ServerResponse<boolean>>;
+export interface AcceptFriendRequestParams {
+  /** The membership id of the user you wish to accept. */
+  membershipId: string;
+}
+/**
+ * Accepts a friend relationship with the target user. The user must be on your
+ * incoming friend request list, though no error will occur if they are not.
+ */
+export declare function acceptFriendRequest(
+  http: HttpClient,
+  params: AcceptFriendRequestParams
+): Promise<ServerResponse<boolean>>;
+export interface DeclineFriendRequestParams {
+  /** The membership id of the user you wish to decline. */
+  membershipId: string;
+}
+/**
+ * Declines a friend relationship with the target user. The user must be on your
+ * incoming friend request list, though no error will occur if they are not.
+ */
+export declare function declineFriendRequest(
+  http: HttpClient,
+  params: DeclineFriendRequestParams
+): Promise<ServerResponse<boolean>>;
+export interface RemoveFriendParams {
+  /** The membership id of the user you wish to remove. */
+  membershipId: string;
+}
+/**
+ * Remove a friend relationship with the target user. The user must be on your
+ * friend list, though no error will occur if they are not.
+ */
+export declare function removeFriend(
+  http: HttpClient,
+  params: RemoveFriendParams
+): Promise<ServerResponse<boolean>>;
+export interface RemoveFriendRequestParams {
+  /** The membership id of the user you wish to remove. */
+  membershipId: string;
+}
+/**
+ * Remove a friend relationship with the target user. The user must be on your
+ * outgoing request friend list, though no error will occur if they are not.
+ */
+export declare function removeFriendRequest(
+  http: HttpClient,
+  params: RemoveFriendRequestParams
+): Promise<ServerResponse<boolean>>;
+export interface GetPlatformFriendListParams {
+  /** The platform friend type. */
+  friendPlatform: PlatformFriendType;
+  /** The zero based page to return. Page size is 100. */
+  page: string;
+}
+/**
+ * Gets the platform friend of the requested type, with additional information if
+ * they have Bungie accounts. Must have a recent login session with said platform.
+ */
+export declare function getPlatformFriendList(
+  http: HttpClient,
+  params: GetPlatformFriendListParams
+): Promise<ServerResponse<PlatformFriendResponse>>;

package/lib/social/api.js

@@ -0,0 +1,26 @@
+import { get, post } from '../http.js';
+const API_BASE = 'https://www.bungie.net/Platform/Social/';
+export function getFriendList(http) {
+  return get(http, `${API_BASE}Friends/`);
+}
+export function getFriendRequestList(http) {
+  return get(http, `${API_BASE}Friends/Requests/`);
+}
+export function issueFriendRequest(http, params) {
+  return post(http, `${API_BASE}Friends/Add/${params.membershipId}/`);
+}
+export function acceptFriendRequest(http, params) {
+  return post(http, `${API_BASE}Friends/Requests/Accept/${params.membershipId}/`);
+}
+export function declineFriendRequest(http, params) {
+  return post(http, `${API_BASE}Friends/Requests/Decline/${params.membershipId}/`);
+}
+export function removeFriend(http, params) {
+  return post(http, `${API_BASE}Friends/Remove/${params.membershipId}/`);
+}
+export function removeFriendRequest(http, params) {
+  return post(http, `${API_BASE}Friends/Requests/Remove/${params.membershipId}/`);
+}
+export function getPlatformFriendList(http, params) {
+  return get(http, `${API_BASE}PlatformFriends/${params.friendPlatform}/${params.page}/`);
+}

package/lib/social/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+export * from '../common.js';
+export * from '../platform.js';
+export type { HttpClientConfig, HttpClient } from '../http.js';
+export * from './api.js';
+export * from './interfaces.js';

package/lib/social/index.js

@@ -0,0 +1,5 @@
+export * from '../common.js';
+export * from '../platform.js';
+export * from './api.js';
+export * from './interfaces.js';
+export {};

package/lib/social/interfaces.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+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 interface BungieFriendListResponse {
+  readonly friends: BungieFriend[];
+}
+export interface BungieFriend {
+  readonly lastSeenAsMembershipId: string;
+  readonly lastSeenAsBungieMembershipType: BungieMembershipType;
+  readonly bungieGlobalDisplayName: string;
+  readonly bungieGlobalDisplayNameCode?: number;
+  readonly onlineStatus: PresenceStatus;
+  /**
+   * This enum represents a set of flags - use bitwise operators to check which of
+   * these match your value.
+   */
+  readonly onlineTitle: PresenceOnlineStateFlags;
+  readonly relationship: FriendRelationshipState;
+  readonly bungieNetUser: GeneralUser;
+}
+export declare const enum PresenceStatus {
+  OfflineOrUnknown = 0,
+  Online = 1,
+}
+/**
+ * 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 interface BungieFriendRequestListResponse {
+  readonly incomingRequests: BungieFriend[];
+  readonly outgoingRequests: BungieFriend[];
+}
+export interface PlatformFriendResponse {
+  readonly itemsPerPage: number;
+  readonly currentPage: number;
+  readonly hasMore: boolean;
+  readonly platformFriends: PlatformFriend[];
+}
+export interface PlatformFriend {
+  readonly platformDisplayName: string;
+  readonly friendPlatform: PlatformFriendType;
+  readonly destinyMembershipId?: string;
+  readonly destinyMembershipType?: BungieMembershipType;
+  readonly bungieNetMembershipId?: string;
+  readonly bungieGlobalDisplayName: string;
+  readonly bungieGlobalDisplayNameCode?: number;
+}

package/lib/social/interfaces.js

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