@taskeren/bungie-api-ts 5.10.2 → 5.10.4

package/README.md

@@ -1,97 +1,101 @@
-# Bungie API TypeScript support
-
-This project implements TypeScript definitions and API helpers for the [Bungie.net API](https://github.com/Bungie-net/api). It's meant for use in [Destiny Item Manager](https://destinyitemmanager.com), but should be general enough to use in any project. The code is completely generated from Bungie's documentation - I considered using something like Swagger Codegen, but instead opted for a custom generator so we could make the result as nice as possible.
-
-# Ports
-
-Feel free to fork this and use it to generate for your favorite language!
-
-- [Dart](https://github.com/marquesinijatinha/bungie-api-dart/)
-
-# Install
-
-```
-pnpm add bungie-api-ts
-```
-
-# Interfaces and Enums
-
-All the interface type definitions and enums are for type info only - everything will compile out. Only the API helpers produce real JavaScript output. You can import types from each service defined on Bungie.net:
-
-```typescript
-import { DestinyInventoryComponent, DestinyInventoryItemDefinition } from 'bungie-api-ts/destiny2';
-```
-
-There are definitions for every type defined in the Bungie.net services. See [their documentation](https://bungie-net.github.io/multi/) for a list - the interface names are the last part of the full name (for example, `Destiny.Definitions.DestinyVendorActionDefinition` becomes `DestinyVendorActionDefinition`). There are a few exceptions, like `SingleComponentResponseOfDestinyInventoryComponent`, which have been mapped into nicer forms like `SingleComponentResponse<DestinyInventoryComponent>`, and the server responses, which are now `ServerResponse<T>` instead of something like `DestinyCharacterResponse`.
-
-# API Helpers
-
-In addition to the types, there are also simple helper functions for each API endpoint. They define the inputs and outputs to that endpoint, and will call a user-provided function with HTTP request info that you can then use to make an HTTP request. This pattern was used so the API helpers could provide full type information. These helpers are not a full API client - they assist in building one. An example:
-
-```typescript
-import { getProfile, HttpClientConfig } from 'bungie-api-ts/destiny2';
-
-async function $http(config: HttpClientConfig) {
-  // fill in the API key, handle OAuth, etc., then make an HTTP request using the config.
-  return fetch(config.url, ...);
-}
-
-const profileInfo: ServerResponse<DestinyProfileResponse> = await getProfile($http, {
-  components: [DestinyComponentType.Profiles, DestinyComponentType.Characters],
-  destinyMembershipId: 12345,
-  membershipType: BungieMembershipType.TigerPsn
-});
-```
-
-# Imports
-
-It is possible to import all services from `bungie-api-ts` directly, but it's better to import the specific service and pick out what you want:
-
-```typescript
-// good
-import { getProfile, HttpClientConfig } from 'bungie-api-ts/destiny2';
-getProfile(...);
-
-// works, but not as good
-import { Destiny2 } from 'bungie-api-ts';
-Destiny2.getProfile(...);
-```
-
-# Manifest Helpers
-
-The `destiny2` import also contains helpers for typing and downloading the Destiny manifest:
-
-```typescript
-import { getDestinyManifestSlice, getDestinyManifest, type HttpClientConfig } from 'bungie-api-ts/destiny2';
-
-async function $http(config: HttpClientConfig) {
-  // fill in the API key, handle OAuth, etc., then make an HTTP request using the config.
-  return fetch(config.url, ...);
-}
-
-const destinyManifest = await getDestinyManifest($http);
-const manifestTables = getDestinyManifestSlice($http, {
-  destinyManifest: destinyManifest.Response,
-  tableNames: ['DestinyInventoryItemDefinition', 'DestinySocketDefinition'],
-  language: 'en',
-});
-
-// manifestTables is an object with properties DestinyInventoryItemDefinition and DestinySocketDefinition
-```
-
-# Build
-
-```
-# setup
-pnpm i && pnpm submodule
-# run
-pnpm start
-```
-
-# Updating API sources
-
-Run the [update API sources](https://github.com/DestinyItemManager/bungie-api-ts/actions/workflows/update.yml) GitHub Action and it should create a new PR for the updated sources.
-
-# Publishing
-
-Update the version in `package.json`, and when the PR merges to `master`, a GitHub workflow will automatically publish to NPM. Don't forget to run `pnpm start` and commit all changed files!
+# Taskeren's Bungie API TypeScript support
+
+This is a fork of [DestinyItemManager/bungie-api-ts](https://github.com/DestinyItemManager/bungie-api-ts), which generates non-const enums.
+
+# Bungie API TypeScript support
+
+This project implements TypeScript definitions and API helpers for the [Bungie.net API](https://github.com/Bungie-net/api). It's meant for use in [Destiny Item Manager](https://destinyitemmanager.com), but should be general enough to use in any project. The code is completely generated from Bungie's documentation - I considered using something like Swagger Codegen, but instead opted for a custom generator so we could make the result as nice as possible.
+
+# Ports
+
+Feel free to fork this and use it to generate for your favorite language!
+
+- [Dart](https://github.com/marquesinijatinha/bungie-api-dart/)
+
+# Install
+
+```
+pnpm add bungie-api-ts
+```
+
+# Interfaces and Enums
+
+All the interface type definitions and enums are for type info only - everything will compile out. Only the API helpers produce real JavaScript output. You can import types from each service defined on Bungie.net:
+
+```typescript
+import { DestinyInventoryComponent, DestinyInventoryItemDefinition } from 'bungie-api-ts/destiny2';
+```
+
+There are definitions for every type defined in the Bungie.net services. See [their documentation](https://bungie-net.github.io/multi/) for a list - the interface names are the last part of the full name (for example, `Destiny.Definitions.DestinyVendorActionDefinition` becomes `DestinyVendorActionDefinition`). There are a few exceptions, like `SingleComponentResponseOfDestinyInventoryComponent`, which have been mapped into nicer forms like `SingleComponentResponse<DestinyInventoryComponent>`, and the server responses, which are now `ServerResponse<T>` instead of something like `DestinyCharacterResponse`.
+
+# API Helpers
+
+In addition to the types, there are also simple helper functions for each API endpoint. They define the inputs and outputs to that endpoint, and will call a user-provided function with HTTP request info that you can then use to make an HTTP request. This pattern was used so the API helpers could provide full type information. These helpers are not a full API client - they assist in building one. An example:
+
+```typescript
+import { getProfile, HttpClientConfig } from 'bungie-api-ts/destiny2';
+
+async function $http(config: HttpClientConfig) {
+  // fill in the API key, handle OAuth, etc., then make an HTTP request using the config.
+  return fetch(config.url, ...);
+}
+
+const profileInfo: ServerResponse<DestinyProfileResponse> = await getProfile($http, {
+  components: [DestinyComponentType.Profiles, DestinyComponentType.Characters],
+  destinyMembershipId: 12345,
+  membershipType: BungieMembershipType.TigerPsn
+});
+```
+
+# Imports
+
+It is possible to import all services from `bungie-api-ts` directly, but it's better to import the specific service and pick out what you want:
+
+```typescript
+// good
+import { getProfile, HttpClientConfig } from 'bungie-api-ts/destiny2';
+getProfile(...);
+
+// works, but not as good
+import { Destiny2 } from 'bungie-api-ts';
+Destiny2.getProfile(...);
+```
+
+# Manifest Helpers
+
+The `destiny2` import also contains helpers for typing and downloading the Destiny manifest:
+
+```typescript
+import { getDestinyManifestSlice, getDestinyManifest, type HttpClientConfig } from 'bungie-api-ts/destiny2';
+
+async function $http(config: HttpClientConfig) {
+  // fill in the API key, handle OAuth, etc., then make an HTTP request using the config.
+  return fetch(config.url, ...);
+}
+
+const destinyManifest = await getDestinyManifest($http);
+const manifestTables = getDestinyManifestSlice($http, {
+  destinyManifest: destinyManifest.Response,
+  tableNames: ['DestinyInventoryItemDefinition', 'DestinySocketDefinition'],
+  language: 'en',
+});
+
+// manifestTables is an object with properties DestinyInventoryItemDefinition and DestinySocketDefinition
+```
+
+# Build
+
+```
+# setup
+pnpm i && pnpm submodule
+# run
+pnpm start
+```
+
+# Updating API sources
+
+Run the [update API sources](https://github.com/DestinyItemManager/bungie-api-ts/actions/workflows/update.yml) GitHub Action and it should create a new PR for the updated sources.
+
+# Publishing
+
+Update the version in `package.json`, and when the PR merges to `master`, a GitHub workflow will automatically publish to NPM. Don't forget to run `pnpm start` and commit all changed files!

package/app/interfaces.d.ts

@@ -61,48 +61,51 @@ export interface Application {
   /** An optional override for the Authorize view name. */
   readonly overrideAuthorizeViewName: string;
 }
-export declare const enum OAuthApplicationType {
-  None = 0,
+export declare const OAuthApplicationType: {
+  readonly None: 0;
   /**
    * Indicates the application is server based and can keep its secrets from end
    * users and other potential snoops.
    */
-  Confidential = 1,
+  readonly Confidential: 1;
   /**
    * Indicates the application runs in a public place, and it can't be trusted to
    * keep a secret.
    */
-  Public = 2,
-}
-export declare const enum ApplicationStatus {
+  readonly Public: 2;
+};
+export type OAuthApplicationType = (typeof OAuthApplicationType)[keyof typeof OAuthApplicationType];
+export declare const ApplicationStatus: {
   /** No value assigned */
-  None = 0,
+  readonly None: 0;
   /**
    * Application exists and works but will not appear in any public catalog. New
    * applications start in this state, test applications will remain in this state.
    */
-  Private = 1,
+  readonly Private: 1;
   /** Active applications that can appear in an catalog. */
-  Public = 2,
+  readonly Public: 2;
   /**
    * Application disabled by the owner. All authorizations will be treated as
    * terminated while in this state. Owner can move back to private or public state.
    */
-  Disabled = 3,
+  readonly Disabled: 3;
   /**
    * Application has been blocked by Bungie. It cannot be transitioned out of this
    * state by the owner. Authorizations are terminated when an application is in this
    * state.
    */
-  Blocked = 4,
-}
+  readonly Blocked: 4;
+};
+export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
 export interface ApplicationDeveloper {
   readonly role: DeveloperRole;
   readonly apiEulaVersion: number;
   readonly user: UserInfoCard;
 }
-export declare const enum DeveloperRole {
-  None = 0,
-  Owner = 1,
-  TeamMember = 2,
-}
+export declare const DeveloperRole: {
+  readonly None: 0;
+  readonly Owner: 1;
+  readonly TeamMember: 2;
+};
+export type DeveloperRole = (typeof DeveloperRole)[keyof typeof DeveloperRole];

package/app/interfaces.js

@@ -1,16 +1,16 @@
-export var OAuthApplicationType = {
+export const OAuthApplicationType = {
   None: 0,
   Confidential: 1,
   Public: 2,
 };
-export var ApplicationStatus = {
+export const ApplicationStatus = {
   None: 0,
   Private: 1,
   Public: 2,
   Disabled: 3,
   Blocked: 4,
 };
-export var DeveloperRole = {
+export const DeveloperRole = {
   None: 0,
   Owner: 1,
   TeamMember: 2,

package/bungie-api-LICENSE

@@ -1,29 +1,29 @@
-Bungie SDK License Agreement (BSD 3-Clause License)
-
-Copyright (c) 2017, Bungie, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Bungie SDK License Agreement (BSD 3-Clause License)
+
+Copyright (c) 2017, Bungie, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.